mirror of
https://github.com/qdrant/landing_page.git
synced 2026-09-28 23:48:31 +02:00
interfaces page
This commit is contained in:
@@ -0,0 +1,73 @@
|
||||
---
|
||||
title: Interfaces
|
||||
weight: 14
|
||||
---
|
||||
|
||||
# Interfaces
|
||||
|
||||
> **Note:** If you are using a language that is not listed here, you can use the REST API directly or generate a client for your language
|
||||
using [OpenAPI](https://github.com/qdrant/qdrant/blob/master/docs/redoc/master/openapi.json)
|
||||
or [protobuf](https://github.com/qdrant/qdrant/tree/master/lib/api/src/grpc/proto) definitions.
|
||||
|
||||
## Client Libraries
|
||||
||Client Repository|Installation|Version|
|
||||
|-|-|-|-|
|
||||
||**[Python](https://github.com/qdrant/qdrant-client)**|`pip install qdrant-client`|**Latest Release**|
|
||||
||**[Typescript](https://github.com/qdrant/qdrant-js)**|`npm install @qdrant/js-client-rest`|**Latest Release**|
|
||||
||**[Rust](https://github.com/qdrant/rust-client)**|`cargo add qdrant-client`|**Latest Release**|
|
||||
||**[Go](https://github.com/qdrant/go-client)**|`go get github.com/qdrant/go-client`|**Latest Release**|
|
||||
|
||||
## API Reference
|
||||
|
||||
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)|
|
||||
|
||||
### gRPC Interface
|
||||
|
||||
The gRPC methods follow the same principles as REST. For each REST endpoint, there is a corresponding gRPC method.
|
||||
|
||||
As per the [configuration file](https://github.com/qdrant/qdrant/blob/master/config/config.yaml), the gRPC interface is available on the specified port.
|
||||
|
||||
```yaml
|
||||
service:
|
||||
grpc_port: 6334
|
||||
```
|
||||
<aside role="status">If you decide to use gRPC, you must expose the port when starting Qdrant.</aside>
|
||||
|
||||
Running the service inside of Docker will look like this:
|
||||
|
||||
```bash
|
||||
docker run -p 6333:6333 -p 6334:6334 \
|
||||
-v $(pwd)/qdrant_storage:/qdrant/storage \
|
||||
qdrant/qdrant
|
||||
```
|
||||
|
||||
**When to use gRPC:** The choice between gRPC and the REST API is a trade-off between convenience and speed. gRPC is a binary protocol and can be more challenging to debug.We recommend switching to it if you are already familiar with Qdrant and are trying to optimize the performance of your application.
|
||||
|
||||
## Qdrant Web UI
|
||||
|
||||
Qdrant's Web UI is an intuitive and efficient graphic interface for your Qdrant Collections, REST API and data points.
|
||||
|
||||
In the **Console**, you may use the REST API to interact with Qdrant, while in **Collections**, you can manage all the collections and upload Snapshots.
|
||||
|
||||

|
||||
|
||||
### Accessing the Web UI
|
||||
|
||||
First, run the Docker container:
|
||||
|
||||
```bash
|
||||
docker run -p 6333:6333 -p 6334:6334 \
|
||||
-v $(pwd)/qdrant_storage:/qdrant/storage \
|
||||
qdrant/qdrant
|
||||
```
|
||||
|
||||
The GUI is available at `http://localhost:6333/dashboard`
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
---
|
||||
title: Python Client
|
||||
weight: 14
|
||||
type: external-link
|
||||
external_url: https://github.com/qdrant/qdrant-client
|
||||
sitemapExclude: True
|
||||
---
|
||||
@@ -69,7 +69,7 @@ client = QdrantClient("localhost", port=6333)
|
||||
|
||||
# Running vector search queries
|
||||
|
||||
In this simple example, you will create a Qdrant collection, load data into it and run a basic search query.
|
||||
In this short example, you will create a Qdrant collection, load data into it and run a basic search query.
|
||||
|
||||

|
||||
|
||||
@@ -179,6 +179,6 @@ You have just conducted vector search. You loaded vectors into a database and qu
|
||||
|
||||
## Next Steps
|
||||
|
||||
Now you know how Qdrant works. Getting started with [Qdrant Cloud](../cloud/quickstart-cloud/)| is even simpler. [Create an account](https://qdrant.to/cloud) and use our SaaS completely free. We will take care of infrastructure maintenance and software updates.
|
||||
Now you know how Qdrant works. Getting started with [Qdrant Cloud](../cloud/quickstart-cloud/) is just as easy. [Create an account](https://qdrant.to/cloud) and use our SaaS completely free. We will take care of infrastructure maintenance and software updates.
|
||||
|
||||
To move onto some more complex examples of vector search, read our [Tutorials](../tutorials/) and create your own app with the help of our [Examples](../examples/).
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 1.3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.9 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 868 B |
Binary file not shown.
|
After Width: | Height: | Size: 844 B |
Reference in New Issue
Block a user