Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update descriptions and endpoints #15

Merged
merged 19 commits into from
May 29, 2024
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
260 changes: 107 additions & 153 deletions fern/api-description-overwrites.yml

Large diffs are not rendered by default.

215 changes: 99 additions & 116 deletions fern/apis/master/openapi-overrides.yml

Large diffs are not rendered by default.

215 changes: 99 additions & 116 deletions fern/apis/v1.9.x/openapi-overrides.yml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion fern/fern.config.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"organization": "qdrant",
"version": "0.23.1"
"version": "0.29.0"
}
25 changes: 25 additions & 0 deletions fern/pages/api-summary.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Qdrant is a [vector database](https://qdrant.tech/documentation/overview/) and a [semantic search](https://qdrant.tech/documentation/overview/vector-search/) engine. You can use its REST API to develop a production-ready service to store, search, and manage vectors with an additional payload.

## How does Qdrant work?

1. First, you should create a [collection](/api-reference/collections/the-collection-object) to store all your data.
2. Then upsert data [points](/api-reference/points/upsert-points) and enrich them with a custom [payload](/api-reference/points/set-payload).
3. With a full collection, run a [search](/api-reference/search/points) to find relevant results.
4. Collections can be [snapshotted, downloaded and restored](/api-reference/snapshots/list-snapshots).
5. When ready, setup a [distributed system](/api-reference/distributed/create-shard-key) for production.

### Just getting started?
Try the [development quickstart](https://qdrant.tech/documentation/quick-start/) guide.

<Aside>
## Client Libraries
|Client|Repository|Installation|
|-|-|-|
|![python](https://qdrant.tech/docs/misc/python.webp)|**[Python](https://github.com/qdrant/qdrant-client)**|`pip install qdrant-client[fastembed]`|
davidmyriel marked this conversation as resolved.
Show resolved Hide resolved
|![typescript](https://qdrant.tech/docs/misc/ts.webp)|**[Typescript](https://github.com/qdrant/qdrant-js)**|`npm install @qdrant/js-client-rest`|
|![rust](https://qdrant.tech/docs/misc/rust.png)|**[Rust](https://github.com/qdrant/rust-client)**|`cargo add qdrant-client`|
Anush008 marked this conversation as resolved.
Show resolved Hide resolved
|![golang](https://qdrant.tech/docs/misc/go.webp)|**[Go](https://github.com/qdrant/go-client)**|`go get github.com/qdrant/go-client`|
|![.net](https://qdrant.tech/docs/misc/dotnet.webp)|**[.NET](https://github.com/qdrant/qdrant-dotnet)**|`dotnet add package Qdrant.Client`|
|![java](https://qdrant.tech/docs/misc/java.webp)|**[Java](https://github.com/qdrant/java-client)**|[Available on Maven Central](https://central.sonatype.com/artifact/io.qdrant/client)|[Latest Release](https://github.com/qdrant/java-client/releases)|

</Aside>
20 changes: 20 additions & 0 deletions fern/pages/collections.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
A collection is a logical grouping for related [points](https://qdrant.tech/documentation/concepts/points/). Each collection can be thought of as a dataset within the database, where you can store, organize, and manage points that share a common purpose or are related in some way.
Each point in a collection consists of one or more vectors with a [payload](https://qdrant.tech/documentation/concepts/payload/).

When querying a vector database, you need to specify the collection you want to [search](https://qdrant.tech/documentation/concepts/search/) within.

Each Qdrant collection has configurable parameters for optimization, index construction, and vacuum.

Read more: [Collections](https://qdrant.tech/documentation/concepts/collections/)

<Aside>
|Endpoints||
|-:|-|
|GET| [Get collection details](/api-reference/collections/delete-collection)|
|GET| [List all collections](/api-reference/collections/get-collections)|
|GET| [Check collection existence](/api-reference/collections/collection-exists)|
|PUT| [Create a collection](/api-reference/collections/create-collection)|
|PATCH| [Update collection parameters](/api-reference/collections/update-collection)|
|DEL| [Delete a collection](/api-reference/collections/delete-collection)|

</Aside>
davidmyriel marked this conversation as resolved.
Show resolved Hide resolved
8 changes: 8 additions & 0 deletions fern/versions/master.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
navigation:
- api: API Reference
api-name: master
summary: ../pages/api-summary.mdx
layout:
- collections:
- page: The Collection object
path: ../pages/collections.mdx



8 changes: 8 additions & 0 deletions fern/versions/v1.9.x.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
navigation:
- api: API Reference
api-name: v1.9.x
summary: ../pages/api-summary.mdx
layout:
- collections:
- page: The Collection object
path: ../pages/collections.mdx