mirror of
https://github.com/qdrant/landing_page.git
synced 2026-09-25 22:18:30 +02:00
docs: Switch over API reference to api.qdrant.tech (#939)
This commit is contained in:
Anush
@@ -216,7 +216,7 @@ Qdrant has a pre-built docker image and start working with it is just as simple
|
||||
docker run -p 6333:6333 qdrant/qdrant
|
||||
```
|
||||
|
||||
Documentation with examples could be found [here](https://qdrant.github.io/qdrant/redoc/index.html).
|
||||
Documentation with examples could be found [here](https://api.qdrant.tech/api-reference).
|
||||
|
||||
|
||||
## Conclusion
|
||||
|
||||
@@ -2,6 +2,6 @@
|
||||
title: API Reference
|
||||
weight: 12
|
||||
type: external-link
|
||||
external_url: https://qdrant.github.io/qdrant/redoc/index.html
|
||||
external_url: https://api.qdrant.tech/api-reference
|
||||
sitemapExclude: True
|
||||
---
|
||||
@@ -137,7 +137,7 @@ In addition to the required options, you can also specify custom values for the
|
||||
|
||||
Default parameters for the optional collection parameters are defined in [configuration file](https://github.com/qdrant/qdrant/blob/master/config/config.yaml).
|
||||
|
||||
See [schema definitions](https://qdrant.github.io/qdrant/redoc/index.html#operation/create_collection) and a [configuration file](https://github.com/qdrant/qdrant/blob/master/config/config.yaml) for more information about collection and vector parameters.
|
||||
See [schema definitions](https://api.qdrant.tech/api-reference/collections/create-collection) and a [configuration file](https://github.com/qdrant/qdrant/blob/master/config/config.yaml) for more information about collection and vector parameters.
|
||||
|
||||
*Available as of v1.2.0*
|
||||
|
||||
@@ -855,7 +855,7 @@ The following parameters can be updated:
|
||||
* `vectors` - vector-specific configuration, including individual `hnsw_config`, `quantization_config` and `on_disk` settings.
|
||||
* `params` - other collection parameters, including `write_consistency_factor` and `on_disk_payload`.
|
||||
|
||||
Full API specification is available in [schema definitions](https://qdrant.github.io/qdrant/redoc/index.html#tag/collections/operation/update_collection).
|
||||
Full API specification is available in [schema definitions](https://api.qdrant.tech/api-reference/collections/update-collection).
|
||||
|
||||
Calls to this endpoint may be blocking as it waits for existing optimizers to
|
||||
finish. We recommended against using this in a production database as it may
|
||||
|
||||
@@ -13,7 +13,7 @@ After mastering the concepts in [search](../search/), you can start exploring yo
|
||||
|
||||
In addition to the regular search, Qdrant also allows you to search based on multiple positive and negative examples. The API is called ***recommend***, and the examples can be point IDs, so that you can leverage the already encoded objects; and, as of v1.6, you can also use raw vectors as input, so that you can create your vectors on the fly without uploading them as points.
|
||||
|
||||
REST API - API Schema definition is available [here](https://qdrant.github.io/qdrant/redoc/index.html#operation/recommend_points)
|
||||
REST API - API Schema definition is available [here](https://api.qdrant.tech/api-reference/search/recommend-points)
|
||||
|
||||
```http
|
||||
POST /collections/{collection_name}/points/recommend
|
||||
@@ -661,7 +661,7 @@ The result of this API contains one array per recommendation requests.
|
||||
|
||||
*Available as of v1.7*
|
||||
|
||||
REST API Schema definition available [here](https://qdrant.github.io/qdrant/redoc/index.html#tag/points/operation/discover_points)
|
||||
REST API Schema definition available [here](https://api.qdrant.tech/api-reference/search/discover-points)
|
||||
|
||||
In this API, Qdrant introduces the concept of `context`, which is used for splitting the space. Context is a set of positive-negative pairs, and each pair divides the space into positive and negative zones. In that mode, the search operation prefers points based on how many positive zones they belong to (or how much they avoid negative zones).
|
||||
|
||||
|
||||
@@ -174,7 +174,7 @@ Notes about the format:
|
||||
[RFC 3339]: https://datatracker.ietf.org/doc/html/rfc3339#section-5.6
|
||||
|
||||
## Create point with payload
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#tag/points/operation/upsert_points))
|
||||
REST API ([Schema](https://api.qdrant.tech/api-reference/points/upsert-points))
|
||||
|
||||
```http
|
||||
PUT /collections/{collection_name}/points
|
||||
@@ -399,7 +399,7 @@ await client.UpsertAsync(
|
||||
|
||||
Set only the given payload values on a point.
|
||||
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/set_payload)):
|
||||
REST API ([Schema](https://api.qdrant.tech/api-reference/points/set-payload)):
|
||||
|
||||
```http
|
||||
POST /collections/{collection_name}/points/payload
|
||||
@@ -656,7 +656,7 @@ Resulting in the following payload:
|
||||
|
||||
Fully replace any existing payload with the given one.
|
||||
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/overwrite_payload)):
|
||||
REST API ([Schema](https://api.qdrant.tech/api-reference/points/overwrite-payload)):
|
||||
|
||||
```http
|
||||
PUT /collections/{collection_name}/points/payload
|
||||
@@ -755,7 +755,7 @@ you want to modify. The alternative is to use filters.
|
||||
|
||||
This method removes all payload keys from specified points
|
||||
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/clear_payload)):
|
||||
REST API ([Schema](https://api.qdrant.tech/api-reference/points/clear-payload)):
|
||||
|
||||
```http
|
||||
POST /collections/{collection_name}/points/payload/clear
|
||||
@@ -822,7 +822,7 @@ You can also use <code>models.FilterSelector</code> to remove the points matchin
|
||||
|
||||
Delete specific payload keys from points.
|
||||
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/delete_payload)):
|
||||
REST API ([Schema](https://api.qdrant.tech/api-reference/points/delete-payload)):
|
||||
|
||||
```http
|
||||
POST /collections/{collection_name}/points/payload/delete
|
||||
@@ -1008,7 +1008,7 @@ In compound queries involving multiple fields, Qdrant will attempt to use the mo
|
||||
|
||||
To create index for the field, you can use the following:
|
||||
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#tag/collections/operation/create_field_index))
|
||||
REST API ([Schema](https://api.qdrant.tech/api-reference/indexes/create-field-index))
|
||||
|
||||
```http
|
||||
PUT /collections/{collection_name}/index
|
||||
@@ -1071,7 +1071,7 @@ await client.CreatePayloadIndexAsync(
|
||||
);
|
||||
```
|
||||
|
||||
The index usage flag is displayed in the payload schema with the [collection info API](https://qdrant.github.io/qdrant/redoc/index.html#operation/get_collection).
|
||||
The index usage flag is displayed in the payload schema with the [collection info API](https://api.qdrant.tech/api-reference/collections/get-collection).
|
||||
|
||||
Payload schema example:
|
||||
|
||||
|
||||
@@ -1050,7 +1050,7 @@ _Available as of v1.2.0_
|
||||
This method updates the specified vectors on the given points. Unspecified
|
||||
vectors are kept unchanged. All given points must exist.
|
||||
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/update_vectors)):
|
||||
REST API ([Schema](https://api.qdrant.tech/api-reference/points/update-vectors)):
|
||||
|
||||
```http
|
||||
PUT /collections/{collection_name}/points/vectors
|
||||
@@ -1198,7 +1198,7 @@ _Available as of v1.2.0_
|
||||
This method deletes just the specified vectors from the given points. Other
|
||||
vectors are kept unchanged. Points are never deleted.
|
||||
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/deleted_vectors)):
|
||||
REST API ([Schema](https://api.qdrant.tech/api-reference/points/delete-vectors)):
|
||||
|
||||
```http
|
||||
POST /collections/{collection_name}/points/vectors/delete
|
||||
@@ -1264,7 +1264,7 @@ Learn how to modify the payload of a point in the [Payload](../payload/#update-p
|
||||
|
||||
## Delete points
|
||||
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/delete_points)):
|
||||
REST API ([Schema](https://api.qdrant.tech/api-reference/points/delete-points)):
|
||||
|
||||
```http
|
||||
POST /collections/{collection_name}/points/delete
|
||||
@@ -1418,7 +1418,7 @@ This example removes all points with `{ "color": "red" }` from the collection.
|
||||
|
||||
There is a method for retrieving points by their ids.
|
||||
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/get_points)):
|
||||
REST API ([Schema](https://api.qdrant.tech/api-reference/points/get-points)):
|
||||
|
||||
```http
|
||||
POST /collections/{collection_name}/points
|
||||
@@ -1482,7 +1482,7 @@ Excluding helps you not to waste traffic transmitting useless data.
|
||||
|
||||
The single point can also be retrieved via the API:
|
||||
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/get_point)):
|
||||
REST API ([Schema](https://api.qdrant.tech/api-reference/points/get-point)):
|
||||
|
||||
```http
|
||||
GET /collections/{collection_name}/points/{point_id}
|
||||
@@ -1499,7 +1499,7 @@ Python client:
|
||||
|
||||
Sometimes it might be necessary to get all stored points without knowing ids, or iterate over points that correspond to a filter.
|
||||
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#operation/scroll_points)):
|
||||
REST API ([Schema](https://api.qdrant.tech/master/api-reference/search/scroll-points)):
|
||||
|
||||
```http
|
||||
POST /collections/{collection_name}/points/scroll
|
||||
@@ -1769,7 +1769,7 @@ Among others, for example, we can highlight the following scenarios:
|
||||
- Determining the number of pages for pagination
|
||||
- Debugging the query execution speed
|
||||
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#tag/points/operation/count_points)):
|
||||
REST API ([Schema](https://api.qdrant.tech/master/api-reference/points/count-points)):
|
||||
|
||||
```http
|
||||
POST /collections/{collection_name}/points/count
|
||||
@@ -1887,7 +1887,7 @@ order. These operations can be batched:
|
||||
|
||||
The following example snippet makes use of all operations.
|
||||
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#tag/points/operation/batch_update)):
|
||||
REST API ([Schema](https://api.qdrant.tech/master/api-reference/points/batch-update)):
|
||||
|
||||
```http
|
||||
POST /collections/{collection_name}/points/batch
|
||||
|
||||
@@ -58,7 +58,7 @@ You can adjust the threshold using a [configuration file](https://github.com/qdr
|
||||
|
||||
Let's look at an example of a search query.
|
||||
|
||||
REST API - API Schema definition is available [here](https://qdrant.github.io/qdrant/redoc/index.html#operation/search_points)
|
||||
REST API - API Schema definition is available [here](https://api.qdrant.tech/master/api-reference/search/points)
|
||||
|
||||
```http
|
||||
POST /collections/{collection_name}/points/search
|
||||
@@ -1160,7 +1160,7 @@ With the ***groups*** API, you will be able to get the best *N* points for each
|
||||
|
||||
### Search groups
|
||||
|
||||
REST API ([Schema](https://qdrant.github.io/qdrant/redoc/index.html#tag/points/operation/search_point_groups)):
|
||||
REST API ([Schema](https://api.qdrant.tech/master/api-reference/search/point-groups)):
|
||||
|
||||
```http
|
||||
POST /collections/{collection_name}/points/search/groups
|
||||
|
||||
@@ -229,7 +229,7 @@ If there are other active replicas of the recovered shards in the cluster, Qdran
|
||||
|
||||
This method of recovery requires the snapshot file to be downloadable from a URL or exist as a local file on the node (like if you [created the snapshot](#create-snapshot) on this node previously). If instead you need to upload a snapshot file, see the next section.
|
||||
|
||||
To recover from a URL or local file use the [snapshot recovery endpoint](https://qdrant.github.io/qdrant/redoc/index.html#tag/collections/operation/recover_from_snapshot). This endpoint accepts either a URL like `https://example.com` or a [file URI](https://en.wikipedia.org/wiki/File_URI_scheme) like `file:///tmp/snapshot-2022-10-10.snapshot`. If the target collection does not exist, it will be created.
|
||||
To recover from a URL or local file use the [snapshot recovery endpoint](https://api.qdrant.tech/master/api-reference/snapshots/recover-from-snapshot). This endpoint accepts either a URL like `https://example.com` or a [file URI](https://en.wikipedia.org/wiki/File_URI_scheme) like `file:///tmp/snapshot-2022-10-10.snapshot`. If the target collection does not exist, it will be created.
|
||||
|
||||
```http
|
||||
PUT /collections/{collection_name}/snapshots/recover
|
||||
@@ -263,7 +263,7 @@ client.recoverSnapshot("{collection_name}", {
|
||||
|
||||
### Recover from an uploaded file
|
||||
|
||||
The snapshot file can also be uploaded as a file and restored using the [recover from uploaded snapshot](https://qdrant.github.io/qdrant/redoc/index.html#tag/collections/operation/recover_from_uploaded_snapshot). This endpoint accepts the raw snapshot data in the request body. If the target collection does not exist, it will be created.
|
||||
The snapshot file can also be uploaded as a file and restored using the [recover from uploaded snapshot](https://api.qdrant.tech/master/api-reference/snapshots/recover-from-uploaded-snapshot). This endpoint accepts the raw snapshot data in the request body. If the target collection does not exist, it will be created.
|
||||
|
||||
```bash
|
||||
curl -X POST 'http://{qdrant-url}:6333/collections/{collection_name}/snapshots/upload?priority=snapshot' \
|
||||
|
||||
@@ -93,7 +93,7 @@ OPTIONS:
|
||||
|
||||
```
|
||||
|
||||
After a successful synchronization you can observe the state of the cluster through the [REST API](https://qdrant.github.io/qdrant/redoc/index.html?v=master#tag/cluster):
|
||||
After a successful synchronization you can observe the state of the cluster through the [REST API](https://api.qdrant.tech/master/api-reference/distributed/cluster-status):
|
||||
|
||||
```http
|
||||
GET /cluster
|
||||
@@ -159,7 +159,7 @@ In practice it means that a majority of nodes agree on what operations should be
|
||||
|
||||
Practically, it means that if the cluster is in a transition state - either electing a new leader after a failure or starting up, the collection update operations will be denied.
|
||||
|
||||
You may use the cluster [REST API](https://qdrant.github.io/qdrant/redoc/index.html?v=master#tag/cluster) to check the state of the consensus.
|
||||
You may use the cluster [REST API](https://api.qdrant.tech/master/api-reference/distributed/cluster-status) to check the state of the consensus.
|
||||
|
||||
## Sharding
|
||||
|
||||
@@ -294,9 +294,9 @@ Shards are evenly distributed across all existing nodes when a collection is fir
|
||||
|
||||
Qdrant allows moving shards between nodes in the cluster and removing nodes from the cluster. This functionality unlocks the ability to dynamically scale the cluster size without downtime. It also allows you to upgrade or migrate nodes without downtime.
|
||||
|
||||
Qdrant provides the information regarding the current shard distribution in the cluster with the [Collection Cluster info API](https://qdrant.github.io/qdrant/redoc/index.html#tag/cluster/operation/collection_cluster_info).
|
||||
Qdrant provides the information regarding the current shard distribution in the cluster with the [Collection Cluster info API](https://api.qdrant.tech/master/api-reference/distributed/collection-cluster-info).
|
||||
|
||||
Use the [Update collection cluster setup API](https://qdrant.github.io/qdrant/redoc/index.html#tag/cluster/operation/update_collection_cluster) to initiate the shard transfer:
|
||||
Use the [Update collection cluster setup API](https://api.qdrant.tech/master/api-reference/distributed/update-collection-cluster) to initiate the shard transfer:
|
||||
|
||||
```http
|
||||
POST /collections/{collection_name}/cluster
|
||||
@@ -315,7 +315,7 @@ After the transfer is initiated, the service will process it based on the used
|
||||
[transfer method](#shard-transfer-method) keeping both shards in sync. Once the
|
||||
transfer is completed, the old shard is deleted from the source node.
|
||||
|
||||
In case you want to downscale the cluster, you can move all shards away from a peer and then remove the peer using the [remove peer API](https://qdrant.github.io/qdrant/redoc/index.html#tag/cluster/operation/remove_peer).
|
||||
In case you want to downscale the cluster, you can move all shards away from a peer and then remove the peer using the [remove peer API](https://api.qdrant.tech/master/api-reference/distributed/remove-peer).
|
||||
|
||||
```http
|
||||
DELETE /cluster/peer/{peer_id}
|
||||
@@ -819,7 +819,7 @@ Since a replication factor of "2" would require twice as much storage space, it
|
||||
|
||||
### Creating new shard replicas
|
||||
|
||||
It is possible to create or delete replicas manually on an existing collection using the [Update collection cluster setup API](https://qdrant.github.io/qdrant/redoc/index.html?v=v0.11.0#tag/cluster/operation/update_collection_cluster).
|
||||
It is possible to create or delete replicas manually on an existing collection using the [Update collection cluster setup API](https://api.qdrant.tech/master/api-reference/distributed/update-collection-cluster).
|
||||
|
||||
A replica can be added on a specific peer by specifying the peer from which to replicate.
|
||||
|
||||
@@ -884,13 +884,13 @@ If the failed node never restarts, you can recover the lost shards if you have a
|
||||
|
||||
If a node fails and it is impossible to recover it, you should exclude the dead node from the consensus and create an empty node.
|
||||
|
||||
To exclude failed nodes from the consensus, use [remove peer](https://qdrant.github.io/qdrant/redoc/index.html#tag/cluster/operation/remove_peer) API.
|
||||
To exclude failed nodes from the consensus, use [remove peer](https://api.qdrant.tech/master/api-reference/distributed/remove-peer) API.
|
||||
Apply the `force` flag if necessary.
|
||||
|
||||
When you create a new node, make sure to attach it to the existing cluster by specifying `--bootstrap` CLI parameter with the URL of any of the running cluster nodes.
|
||||
|
||||
Once the new node is ready and synchronized with the cluster, you might want to ensure that the collection shards are replicated enough. Remember that Qdrant will not automatically balance shards since this is an expensive operation.
|
||||
Use the [Replicate Shard Operation](https://qdrant.github.io/qdrant/redoc/index.html#tag/cluster/operation/update_collection_cluster) to create another copy of the shard on the newly connected node.
|
||||
Use the [Replicate Shard Operation](https://api.qdrant.tech/master/api-reference/distributed/update-collection-cluster) to create another copy of the shard on the newly connected node.
|
||||
|
||||
It's worth mentioning that Qdrant only provides the necessary building blocks to create an automated failure recovery.
|
||||
Building a completely automatic process of collection scaling would require control over the cluster machines themself.
|
||||
@@ -903,7 +903,7 @@ If there are no copies of data in the cluster, it is still possible to recover f
|
||||
|
||||
Follow the same steps to detach failed node and create a new one in the cluster:
|
||||
|
||||
* To exclude failed nodes from the consensus, use [remove peer](https://qdrant.github.io/qdrant/redoc/index.html#tag/cluster/operation/remove_peer) API. Apply the `force` flag if necessary.
|
||||
* To exclude failed nodes from the consensus, use [remove peer](https://api.qdrant.tech/master/api-reference/distributed/remove-peer) API. Apply the `force` flag if necessary.
|
||||
* Create a new node, making sure to attach it to the existing cluster by specifying the `--bootstrap` CLI parameter with the URL of any of the running cluster nodes.
|
||||
|
||||
Snapshot recovery, used in single-node deployment, is different from cluster one.
|
||||
|
||||
@@ -50,7 +50,7 @@ There are several different techniques that we use to anonymize the data:
|
||||
- We replace all names with irreversibly hashed values. So no collection or field names will leak into the telemetry.
|
||||
- All urls are hashed as well.
|
||||
|
||||
You can see exact version of anomymized collected data by accessing the [telemetry API](https://qdrant.github.io/qdrant/redoc/index.html#tag/service/operation/telemetry) with `anonymize=true` parameter.
|
||||
You can see exact version of anomymized collected data by accessing the [telemetry API](https://api.qdrant.tech/master/api-reference/service/telemetry) with `anonymize=true` parameter.
|
||||
|
||||
For example, <http://localhost:6333/telemetry?details_level=6&anonymize=true>
|
||||
|
||||
|
||||
@@ -28,10 +28,10 @@ or [protobuf](https://github.com/qdrant/qdrant/tree/master/lib/api/src/grpc/prot
|
||||
|
||||
All interaction with Qdrant takes place via the REST API. We recommend using REST API if you are using Qdrant for the first time or if you are working on a prototype.
|
||||
|
||||
|API|Documentation|
|
||||
|-|-|
|
||||
| REST API |[OpenAPI Specification](https://qdrant.github.io/qdrant/redoc/index.html)|
|
||||
| gRPC API| [gRPC Documentation](https://github.com/qdrant/qdrant/blob/master/docs/grpc/docs.md)|
|
||||
| API | Documentation |
|
||||
| -------- | ------------------------------------------------------------------------------------ |
|
||||
| REST API | [OpenAPI Specification](https://api.qdrant.tech/api-reference) |
|
||||
| gRPC API | [gRPC Documentation](https://github.com/qdrant/qdrant/blob/master/docs/grpc/docs.md) |
|
||||
|
||||
### gRPC Interface
|
||||
|
||||
|
||||
@@ -7,5 +7,5 @@ weight: 10
|
||||
sitemapExclude: True
|
||||
---
|
||||
|
||||
Provides the [OpenAPI v3 specification](https://qdrant.github.io/qdrant/redoc/index.html) to generate a client library in almost any programming language.
|
||||
Provides the [OpenAPI v3 specification](https://api.qdrant.tech/api-reference) to generate a client library in almost any programming language.
|
||||
Alternatively utilise [ready-made client for Python](https://github.com/qdrant/qdrant-client) or other programming languages with additional functionality.
|
||||
Reference in New Issue
Block a user