docs: Misc improvements (#1252)

* docs: misc-updates

* chore: host kwarg quickstart-cloud.md
This commit is contained in:
Anush
2024-10-25 14:29:20 +02:00
committed by GitHub
parent c82bcff005
commit a561499b56
3 changed files with 78 additions and 3 deletions
@@ -8,7 +8,7 @@ aliases:
# Configuration # Configuration
Qdrant ships with sensible defaults for collection and network settings that are suitable for most use cases. You can view these default settings in the [Qdrant source](https://github.com/qdrant/qdrant/blob/master/config/config.yaml). If you need to customize these settings, you can do so using configuration files and environment variables. Qdrant ships with sensible defaults for collection and network settings that are suitable for most use cases. You can view these defaults in the [Qdrant source](https://github.com/qdrant/qdrant/blob/master/config/config.yaml). If you need to customize the settings, you can do so using configuration files and environment variables.
<aside role="status"> <aside role="status">
Qdrant Cloud does not allow modifying the Qdrant configuration. Qdrant Cloud does not allow modifying the Qdrant configuration.
@@ -27,11 +27,87 @@ aliases:
## Access the cluster dashboard ## Access the cluster dashboard
1. Go to your **Clusters**. Under **Actions**, open the **Dashboard**. 1. Go to your **Clusters**. Under **Actions**, open the **Dashboard**.
2. Paste your new API key here. If you lost it, make another in **Access Management**. 2. Paste your new API key here. You can revoke and create new API keys in **Access Management**.
3. The key will grant you access to your Qdrant instance. Now you can see the cluster Dashboard. 3. The key will grant you access to your Qdrant instance. Now you can see the cluster Dashboard.
![access the dashboard](/docs/gettingstarted/gui-quickstart/access-dashboard.png) ![access the dashboard](/docs/gettingstarted/gui-quickstart/access-dashboard.png)
## Authenticate via SDKs
Now that you have your cluster and key, you can use our official SDKs to access Qdrant Cloud from within your application.
```bash
curl \
-X GET https://xyz-example.eu-central.aws.cloud.qdrant.io:6333 \
--header 'api-key: <your-api-key>'
# Alternatively, you can use the `Authorization` header with the `Bearer` prefix
curl \
-X GET https://xyz-example.eu-central.aws.cloud.qdrant.io:6333 \
--header 'Authorization: Bearer <your-api-key>'
```
```python
from qdrant_client import QdrantClient
qdrant_client = QdrantClient(
host="xyz-example.eu-central.aws.cloud.qdrant.io",
api_key="<your-api-key>",
)
```
```typescript
import { QdrantClient } from "@qdrant/js-client-rest";
const client = new QdrantClient({
host: "xyz-example.eu-central.aws.cloud.qdrant.io",
apiKey: "<your-api-key>",
});
```
```rust
use qdrant_client::Qdrant;
let client = Qdrant::from_url("https://xyz-example.eu-central.aws.cloud.qdrant.io:6334")
.api_key("<your-api-key>")
.build()?;
```
```java
import io.qdrant.client.QdrantClient;
import io.qdrant.client.QdrantGrpcClient;
QdrantClient client =
new QdrantClient(
QdrantGrpcClient.newBuilder(
"xyz-example.eu-central.aws.cloud.qdrant.io",
6334,
true)
.withApiKey("<your-api-key>")
.build());
```
```csharp
using Qdrant.Client;
var client = new QdrantClient(
host: "xyz-example.eu-central.aws.cloud.qdrant.io",
https: true,
apiKey: "<your-api-key>"
);
```
```go
import "github.com/qdrant/go-client/qdrant"
client, err := qdrant.NewClient(&qdrant.Config{
Host: "xyz-example.eu-central.aws.cloud.qdrant.io",
Port: 6334,
APIKey: "<your-api-key>",
UseTLS: true,
})
```
## Try the Tutorial sandbox ## Try the Tutorial sandbox
1. Open the interactive **Tutorial**. Here, you can test basic Qdrant API requests. 1. Open the interactive **Tutorial**. Here, you can test basic Qdrant API requests.
@@ -10,7 +10,6 @@
} }
figcaption, figcaption,
figcaption p { figcaption p {
color: $caption-color;
font-size: $caption-size; font-size: $caption-size;
text-align: center; text-align: center;
margin-top: $margin; margin-top: $margin;