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 all 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
262 changes: 108 additions & 154 deletions fern/api-description-overwrites.yml

Large diffs are not rendered by default.

217 changes: 100 additions & 117 deletions fern/apis/master/openapi-overrides.yml

Large diffs are not rendered by default.

88 changes: 70 additions & 18 deletions fern/apis/master/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -5719,7 +5719,8 @@
"type": "string",
"enum": [
"float32",
"uint8"
"uint8",
"float16"
]
},
"MultiVectorConfig": {
Expand Down Expand Up @@ -6316,7 +6317,7 @@
],
"properties": {
"indices": {
"description": "indices must be unique",
"description": "Indices must be unique",
"type": "array",
"items": {
"type": "integer",
Expand All @@ -6325,7 +6326,7 @@
}
},
"values": {
"description": "values and indices must be the same length",
"description": "Values and indices must be the same length",
"type": "array",
"items": {
"type": "number",
Expand Down Expand Up @@ -6483,11 +6484,20 @@
"properties": {
"should": {
"description": "At least one of those conditions should match",
"type": "array",
"items": {
"$ref": "#/components/schemas/Condition"
},
"nullable": true
"anyOf": [
{
"$ref": "#/components/schemas/Condition"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Condition"
}
},
{
"nullable": true
}
]
},
"min_should": {
"description": "At least minimum amount of given conditions should match",
Expand All @@ -6502,19 +6512,37 @@
},
"must": {
"description": "All conditions must match",
"type": "array",
"items": {
"$ref": "#/components/schemas/Condition"
},
"nullable": true
"anyOf": [
{
"$ref": "#/components/schemas/Condition"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Condition"
}
},
{
"nullable": true
}
]
},
"must_not": {
"description": "All conditions must NOT match",
"type": "array",
"items": {
"$ref": "#/components/schemas/Condition"
},
"nullable": true
"anyOf": [
{
"$ref": "#/components/schemas/Condition"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Condition"
}
},
{
"nullable": true
}
]
}
},
"additionalProperties": false
Expand Down Expand Up @@ -7121,9 +7149,32 @@
"nullable": true
}
]
},
"order_value": {
"description": "Order-by value",
"anyOf": [
{
"$ref": "#/components/schemas/OrderValue"
},
{
"nullable": true
}
]
}
}
},
"OrderValue": {
"anyOf": [
{
"type": "integer",
"format": "int64"
},
{
"type": "number",
"format": "double"
}
]
},
"UpdateResult": {
"type": "object",
"required": [
Expand Down Expand Up @@ -9341,6 +9392,7 @@
"type": "string",
"enum": [
"float32",
"float16",
"uint8"
]
},
Expand Down
217 changes: 100 additions & 117 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`|
|![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>
5 changes: 5 additions & 0 deletions fern/versions/master.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
navigation:
- api: API Reference
api-name: master
summary: ../pages/api-summary.mdx




5 changes: 5 additions & 0 deletions fern/versions/v1.9.x.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
navigation:
- api: API Reference
api-name: v1.9.x
summary: ../pages/api-summary.mdx




2 changes: 1 addition & 1 deletion qdrant
Submodule qdrant updated from 34f7f8 to 671cf9