From a6b3120a26c805e0788027c68dd1939bd927f97f Mon Sep 17 00:00:00 2001 From: timvisee Date: Tue, 28 Nov 2023 17:05:01 +0100 Subject: [PATCH] Remove empty lines in HTTP examples, reformat some of them --- .../content/articles/memory-consumption.md | 4 +- .../articles/new-recommendation-api.md | 3 +- .../content/articles/qdrant-1.3.x.md | 2 - .../documentation/concepts/collections.md | 11 ----- .../documentation/concepts/filtering.md | 16 +------ .../documentation/concepts/indexing.md | 2 - .../content/documentation/concepts/payload.md | 5 --- .../content/documentation/concepts/points.md | 24 ++-------- .../content/documentation/concepts/search.md | 17 ++----- .../documentation/concepts/snapshots.md | 1 - .../content/documentation/concepts/storage.md | 3 -- .../guides/distributed_deployment.md | 44 ++++++++----------- .../guides/multiple-partitions.md | 4 -- .../content/documentation/guides/optimize.md | 14 ++---- .../documentation/guides/quantization.md | 10 +---- .../documentation/tutorials/bulk-upload.md | 5 +-- 16 files changed, 34 insertions(+), 131 deletions(-) diff --git a/qdrant-landing/content/articles/memory-consumption.md b/qdrant-landing/content/articles/memory-consumption.md index 70309dbea..596a37397 100644 --- a/qdrant-landing/content/articles/memory-consumption.md +++ b/qdrant-landing/content/articles/memory-consumption.md @@ -173,8 +173,7 @@ In the second experiment, we tested how well our system performs when **vectors Create collection with: ```http -PUT /collections/benchmark - +PUT /collections/benchmark { ... "optimizers_config": { @@ -222,7 +221,6 @@ Create collection with: ```http PUT /collections/benchmark - { ... "hnsw_config": { diff --git a/qdrant-landing/content/articles/new-recommendation-api.md b/qdrant-landing/content/articles/new-recommendation-api.md index 493958315..97eb7b47d 100644 --- a/qdrant-landing/content/articles/new-recommendation-api.md +++ b/qdrant-landing/content/articles/new-recommendation-api.md @@ -35,9 +35,8 @@ combine them within a single request. That makes the new implementation backward Qdrant instance without any changes in your code. And the default behaviour of the API is still the same as before. However, we extended the API, so **you can now choose the strategy of how to find the recommended points**. -```http request +```http POST /collections/{collection_name}/points/recommend - { "positive": [100, 231], "negative": [718, [0.2, 0.3, 0.4, 0.5]], diff --git a/qdrant-landing/content/articles/qdrant-1.3.x.md b/qdrant-landing/content/articles/qdrant-1.3.x.md index 2d487b10a..6e12efb30 100644 --- a/qdrant-landing/content/articles/qdrant-1.3.x.md +++ b/qdrant-landing/content/articles/qdrant-1.3.x.md @@ -69,7 +69,6 @@ Here is how you can configure the oversampling factor - define how many extra ve ```http POST /collections/{collection_name}/points/search - { "params": { "quantization": { @@ -122,7 +121,6 @@ When using the grouping API, add the `with_lookup` parameter to bring the inform ```http POST /collections/chunks/points/search/groups - { // Same as in the regular search API "vector": [1.1], diff --git a/qdrant-landing/content/documentation/concepts/collections.md b/qdrant-landing/content/documentation/concepts/collections.md index 366e0557f..b911fa4f3 100644 --- a/qdrant-landing/content/documentation/concepts/collections.md +++ b/qdrant-landing/content/documentation/concepts/collections.md @@ -33,7 +33,6 @@ These settings can be changed at any time by a corresponding request. ```http PUT /collections/{collection_name} - { "vectors": { "size": 300, @@ -121,7 +120,6 @@ Make sure the vectors have the same size and distance function when setting up t ```http PUT /collections/{collection_name} - { "vectors": { "size": 100, @@ -192,7 +190,6 @@ Each named vector in this mode has its distance and size: ```http PUT /collections/{collection_name} - { "vectors": { "image": { @@ -323,7 +320,6 @@ The following command enables indexing for segments that have more than 10000 kB ```http PATCH /collections/{collection_name} - { "optimizers_config": { "indexing_threshold": 10000 @@ -390,7 +386,6 @@ use `""` as name: ```http PATCH /collections/{collection_name} - { "vectors": { "": { @@ -404,7 +399,6 @@ To put vector data on disk for a collection that **does have** named vectors: ```http PATCH /collections/{collection_name} - { "vectors": { "my_vector": { @@ -419,7 +413,6 @@ both for the whole collection, and for `my_vector` specifically: ```http PATCH /collections/{collection_name} - { "vectors": { "my_vector": { @@ -568,7 +561,6 @@ distributed and indexed. ```http GET /collections/{collection_name} - { "result": { "status": "green", @@ -669,7 +661,6 @@ Since all changes of aliases happen atomically, no concurrent requests will be a ```http POST /collections/aliases - { "actions": [ { @@ -715,7 +706,6 @@ client.create_alias("example_collection", "production_collection").await?; ```http POST /collections/aliases - { "actions": [ { @@ -760,7 +750,6 @@ For example, you can switch underlying collection with the following command: ```http POST /collections/aliases - { "actions": [ { diff --git a/qdrant-landing/content/documentation/concepts/filtering.md b/qdrant-landing/content/documentation/concepts/filtering.md index 98ab3d195..3368cdc4a 100644 --- a/qdrant-landing/content/documentation/concepts/filtering.md +++ b/qdrant-landing/content/documentation/concepts/filtering.md @@ -40,7 +40,6 @@ Example: ```http POST /collections/{collection_name}/points/scroll - { "filter": { "must": [ @@ -48,7 +47,7 @@ POST /collections/{collection_name}/points/scroll { "key": "color", "match": { "value": "red" } } ] } - ... + ... } ``` @@ -131,7 +130,6 @@ Example: ```http POST /collections/{collection_name}/points/scroll - { "filter": { "should": [ @@ -212,7 +210,6 @@ Example: ```http POST /collections/{collection_name}/points/scroll - { "filter": { "must_not": [ @@ -285,7 +282,6 @@ It is also possible to use several clauses simultaneously: ```http POST /collections/{collection_name}/points/scroll - { "filter": { "must": [ @@ -362,7 +358,6 @@ Also, the conditions could be recursively nested. Example: ```http POST /collections/{collection_name}/points/scroll - { "filter": { "must_not": [ @@ -657,7 +652,6 @@ You can search on a nested field using a dot notation. ```http POST /collections/{collection_name}/points/scroll - { "filter": { "should": [ @@ -717,7 +711,6 @@ You can also search through arrays by projecting inner values using the `[]` syn ```http POST /collections/{collection_name}/points/scroll - { "filter": { "should": [ @@ -793,7 +786,6 @@ And the leaf nested field can also be an array. ```http POST /collections/{collection_name}/points/scroll - { "filter": { "should": [ @@ -885,7 +877,6 @@ The following query would match both points: ```http POST /collections/{collection_name}/points/scroll - { "filter": { "must": [ @@ -969,7 +960,6 @@ The key should point to an array of objects and can be used with or without the ```http POST /collections/{collection_name}/points/scroll - { "filter": { "must": [ @@ -1080,7 +1070,6 @@ The `has_id` condition is not supported within the nested object filter. If you ```http POST /collections/{collection_name}/points/scroll - { "filter": { "must": [ @@ -1762,14 +1751,13 @@ For example, the user could mark some specific search results as irrelevant, or ```http POST /collections/{collection_name}/points/scroll - { "filter": { "must": [ { "has_id": [1,3,5,7,9,11] } ] } - ... + ... } ``` diff --git a/qdrant-landing/content/documentation/concepts/indexing.md b/qdrant-landing/content/documentation/concepts/indexing.md index cc125ca74..57c6f7808 100644 --- a/qdrant-landing/content/documentation/concepts/indexing.md +++ b/qdrant-landing/content/documentation/concepts/indexing.md @@ -27,7 +27,6 @@ To mark a field as indexable, you can use the following: ```http PUT /collections/{collection_name}/index - { "field_name": "name_of_the_field_to_index", "field_schema": "keyword" @@ -100,7 +99,6 @@ To create a full-text index, you can use the following: ```http PUT /collections/{collection_name}/index - { "field_name": "name_of_the_field_to_index", "field_schema": { diff --git a/qdrant-landing/content/documentation/concepts/payload.md b/qdrant-landing/content/documentation/concepts/payload.md index 9b370cef8..199bf93db 100644 --- a/qdrant-landing/content/documentation/concepts/payload.md +++ b/qdrant-landing/content/documentation/concepts/payload.md @@ -142,7 +142,6 @@ REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#tag/points/o ```http PUT /collections/{collection_name}/points - { "points": [ { @@ -285,7 +284,6 @@ REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/se ```http POST /collections/{collection_name}/points/payload - { "payload": { "property1": "string", @@ -351,7 +349,6 @@ REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/de ```http POST /collections/{collection_name}/points/payload/delete - { "keys": ["color", "price"], "points": [0, 3, 100] @@ -400,7 +397,6 @@ REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/cl ```http POST /collections/{collection_name}/points/payload/clear - { "points": [0, 3, 100] } @@ -458,7 +454,6 @@ REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#tag/collecti ```http PUT /collections/{collection_name}/index - { "field_name": "name_of_the_field_to_index", "field_schema": "keyword" diff --git a/qdrant-landing/content/documentation/concepts/points.md b/qdrant-landing/content/documentation/concepts/points.md index 03cd26149..0e5e7e9b9 100755 --- a/qdrant-landing/content/documentation/concepts/points.md +++ b/qdrant-landing/content/documentation/concepts/points.md @@ -70,7 +70,6 @@ Example: ```http PUT /collections/{collection_name}/points - { "points": [ { @@ -147,7 +146,6 @@ and ```http PUT /collections/{collection_name}/points - { "points": [ { @@ -223,7 +221,6 @@ Create points with batch: ```http PUT /collections/{collection_name}/points - { "batch": { "ids": [1, 2, 3], @@ -279,7 +276,6 @@ or record-oriented equivalent: ```http PUT /collections/{collection_name}/points - { "points": [ { @@ -415,9 +411,9 @@ Even with such a system, Qdrant ensures data consistency. *Available as of v0.10.0* If the collection was created with multiple vectors, each vector data can be provided using the vector's name: + ```http PUT /collections/{collection_name}/points - { "points": [ { @@ -544,7 +540,6 @@ REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/up ```http PUT /collections/{collection_name}/points/vectors - { "points": [ { @@ -646,7 +641,6 @@ REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/de ```http POST /collections/{collection_name}/points/vectors/delete - { "points": [0, 3, 100], "vectors": ["text", "image"] @@ -701,7 +695,6 @@ REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/se ```http POST /collections/{collection_name}/points/payload - { "payload": { "property1": "string", @@ -764,7 +757,6 @@ is to use filters. ```http POST /collections/{collection_name}/points/payload - { "payload": { "property1": "string", @@ -853,7 +845,6 @@ REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/ov ```http PUT /collections/{collection_name}/points/payload - { "payload": { "property1": "string", @@ -920,7 +911,6 @@ REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/de ```http POST /collections/{collection_name}/points/payload/delete - { "keys": ["color", "price"], "points": [0, 3, 100] @@ -965,7 +955,6 @@ Alternatively, you can use filters to delete payload keys from the points. ```http POST /collections/{collection_name}/points/payload/delete - { "keys": ["color", "price"], "filter": { @@ -1039,7 +1028,6 @@ REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/cl ```http POST /collections/{collection_name}/points/payload/clear - { "points": [0, 3, 100] } @@ -1084,7 +1072,6 @@ REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/de ```http POST /collections/{collection_name}/points/delete - { "points": [0, 3, 100] } @@ -1127,7 +1114,6 @@ Alternative way to specify which points to remove is to use filter. ```http POST /collections/{collection_name}/points/delete - { "filter": { "must": [ @@ -1201,7 +1187,6 @@ REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/ge ```http POST /collections/{collection_name}/points - { "ids": [0, 3, 100] } @@ -1244,7 +1229,7 @@ REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/ge GET /collections/{collection_name}/points/{point_id} ``` -