Skip to content

Commit 4287340

Browse files
authored
docs: Proofread and updated snippets (#1243)
1 parent a092bc9 commit 4287340

File tree

10 files changed

+101
-98
lines changed

10 files changed

+101
-98
lines changed

qdrant-landing/content/documentation/concepts/explore.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1395,7 +1395,7 @@ QdrantClient client =
13951395
client
13961396
.searchMatrixPairsAsync(
13971397
Points.SearchMatrixPoints.newBuilder()
1398-
.setCollectionName(collectionName)
1398+
.setCollectionName("{collection_name}")
13991399
.setFilter(Filter.newBuilder().addMust(matchKeyword("color", "red")).build())
14001400
.setSample(10)
14011401
.setLimit(2)
@@ -1448,7 +1448,7 @@ using static Qdrant.Client.Grpc.Conditions;
14481448

14491449
var client = new QdrantClient("localhost", 6334);
14501450

1451-
await client.SearchMatrixPairs(
1451+
await client.SearchMatrixPairsAsync(
14521452
collectionName: "{collection_name}",
14531453
filter: MatchKeyword("color", "red"),
14541454
sample: 10,
@@ -1561,7 +1561,7 @@ QdrantClient client =
15611561
client
15621562
.searchMatrixOffsetsAsync(
15631563
SearchMatrixPoints.newBuilder()
1564-
.setCollectionName(collectionName)
1564+
.setCollectionName("{collection_name}")
15651565
.setFilter(Filter.newBuilder().addMust(matchKeyword("color", "red")).build())
15661566
.setSample(10)
15671567
.setLimit(2)
@@ -1614,7 +1614,7 @@ using static Qdrant.Client.Grpc.Conditions;
16141614

16151615
var client = new QdrantClient("localhost", 6334);
16161616

1617-
await client.SearchMatrixOffsets(
1617+
await client.SearchMatrixOffsetsAsync(
16181618
collectionName: "{collection_name}",
16191619
filter: MatchKeyword("color", "red"),
16201620
sample: 10,

qdrant-landing/content/documentation/concepts/filtering.md

+56-54
Original file line numberDiff line numberDiff line change
@@ -2158,22 +2158,22 @@ Functionally, it will work with `keyword` and `uuid` indexes exactly the same, b
21582158
{
21592159
"key": "uuid",
21602160
"match": {
2161-
"uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
2161+
"value": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
21622162
}
21632163
}
21642164
```
21652165

21662166
```python
21672167
models.FieldCondition(
21682168
key="uuid",
2169-
match=models.MatchValue(uuid="f47ac10b-58cc-4372-a567-0e02b2c3d479"),
2169+
match=models.MatchValue(value="f47ac10b-58cc-4372-a567-0e02b2c3d479"),
21702170
)
21712171
```
21722172

21732173
```typescript
21742174
{
21752175
key: 'uuid',
2176-
match: {uuid: 'f47ac10b-58cc-4372-a567-0e02b2c3d479'}
2176+
match: {value: 'f47ac10b-58cc-4372-a567-0e02b2c3d479'}
21772177
}
21782178
```
21792179

@@ -2462,57 +2462,59 @@ models.FieldCondition(
24622462

24632463
```typescript
24642464
{
2465-
key: 'location',
2466-
geo_polygon: {
2467-
exterior: {
2468-
points: [
2469-
{
2470-
lon: -70.0,
2471-
lat: -70.0
2472-
},
2473-
{
2474-
lon: 60.0,
2475-
lat: -70.0
2476-
},
2477-
{
2478-
lon: 60.0,
2479-
lat: 60.0
2480-
},
2481-
{
2482-
lon: -70.0,
2483-
lat: 60.0
2484-
},
2485-
{
2486-
lon: -70.0,
2487-
lat: -70.0
2488-
}
2489-
]
2465+
key: "location",
2466+
geo_polygon: {
2467+
exterior: {
2468+
points: [
2469+
{
2470+
lon: -70.0,
2471+
lat: -70.0
24902472
},
2491-
interiors: {
2492-
points: [
2493-
{
2494-
lon: -65.0,
2495-
lat: -65.0
2496-
},
2497-
{
2498-
lon: 0.0,
2499-
lat: -65.0
2500-
},
2501-
{
2502-
lon: 0.0,
2503-
lat: 0.0
2504-
},
2505-
{
2506-
lon: -65.0,
2507-
lat: 0.0
2508-
},
2509-
{
2510-
lon: -65.0,
2511-
lat: -65.0
2512-
}
2513-
]
2473+
{
2474+
lon: 60.0,
2475+
lat: -70.0
2476+
},
2477+
{
2478+
lon: 60.0,
2479+
lat: 60.0
2480+
},
2481+
{
2482+
lon: -70.0,
2483+
lat: 60.0
2484+
},
2485+
{
2486+
lon: -70.0,
2487+
lat: -70.0
25142488
}
2515-
}
2489+
]
2490+
},
2491+
interiors: [
2492+
{
2493+
points: [
2494+
{
2495+
lon: -65.0,
2496+
lat: -65.0
2497+
},
2498+
{
2499+
lon: 0,
2500+
lat: -65.0
2501+
},
2502+
{
2503+
lon: 0,
2504+
lat: 0
2505+
},
2506+
{
2507+
lon: -65.0,
2508+
lat: 0
2509+
},
2510+
{
2511+
lon: -65.0,
2512+
lat: -65.0
2513+
}
2514+
]
2515+
}
2516+
]
2517+
}
25162518
}
25172519
```
25182520

@@ -2764,7 +2766,7 @@ models.IsEmptyCondition(
27642766
```typescript
27652767
{
27662768
is_empty: {
2767-
key: "reports";
2769+
key: "reports"
27682770
}
27692771
}
27702772
```
@@ -2820,7 +2822,7 @@ models.IsNullCondition(
28202822
```typescript
28212823
{
28222824
is_null: {
2823-
key: "reports";
2825+
key: "reports"
28242826
}
28252827
}
28262828
```

qdrant-landing/content/documentation/concepts/hybrid-queries.md

+25-25
Original file line numberDiff line numberDiff line change
@@ -296,14 +296,14 @@ import { QdrantClient } from "@qdrant/js-client-rest";
296296
const client = new QdrantClient({ host: "localhost", port: 6333 });
297297

298298
client.query("{collection_name}", {
299-
prefetch: {
300-
query: [1, 23, 45, 67], // <------------- small byte vector
301-
using: 'mrl_byte',
302-
limit: 1000,
303-
},
304-
query: [0.01, 0.299, 0.45, 0.67, ...], // <-- full vector,
305-
using: 'full',
306-
limit: 10,
299+
prefetch: {
300+
query: [1, 23, 45, 67], // <------------- small byte vector
301+
using: 'mrl_byte',
302+
limit: 1000,
303+
},
304+
query: [0.01, 0.299, 0.45, 0.67], // <-- full vector,
305+
using: 'full',
306+
limit: 10,
307307
});
308308
```
309309

@@ -628,23 +628,23 @@ import { QdrantClient } from "@qdrant/js-client-rest";
628628
const client = new QdrantClient({ host: "localhost", port: 6333 });
629629

630630
client.query("{collection_name}", {
631+
prefetch: {
631632
prefetch: {
632-
prefetch: {
633-
query: [1, 23, 45, 67, ...], // <------------- small byte vector
634-
using: 'mrl_byte',
635-
limit: 1000,
636-
},
637-
query: [0.01, 0.45, 0.67, ...], // <-- full dense vector
638-
using: 'full',
639-
limit: 100,
633+
query: [1, 23, 45, 67], // <------------- small byte vector
634+
using: 'mrl_byte',
635+
limit: 1000,
640636
},
641-
query: [
642-
[0.1, 0.2], // <─┐
643-
[0.2, 0.1], // < ├─ multi-vector
644-
[0.8, 0.9], // < ┘
645-
],
646-
using: 'colbert',
647-
limit: 10,
637+
query: [0.01, 0.45, 0.67], // <-- full dense vector
638+
using: 'full',
639+
limit: 100,
640+
},
641+
query: [
642+
[0.1, 0.2], // <─┐
643+
[0.2, 0.1], // < ├─ multi-vector
644+
[0.8, 0.9], // < ┘
645+
],
646+
using: 'colbert',
647+
limit: 10,
648648
});
649649
```
650650

@@ -832,7 +832,7 @@ let client = Qdrant::from_url("http://localhost:6334").build()?;
832832
client
833833
.query(
834834
QueryPointsBuilder::new("{collection_name}")
835-
.query(Query::new_nearest(PointId::new("43cf51e2-8777-4f52-bc74-c2cbde0c8b04")))
835+
.query(Query::new_nearest("43cf51e2-8777-4f52-bc74-c2cbde0c8b04")),
836836
)
837837
.await?;
838838
```
@@ -943,7 +943,7 @@ let client = Qdrant::from_url("http://localhost:6334").build()?;
943943

944944
client.query(
945945
QueryPointsBuilder::new("{collection_name}")
946-
.query(Query::new_nearest(PointId::new("43cf51e2-8777-4f52-bc74-c2cbde0c8b04")))
946+
.query(Query::new_nearest("43cf51e2-8777-4f52-bc74-c2cbde0c8b04"))
947947
.using("512d-vector")
948948
.lookup_from(
949949
LookupLocationBuilder::new("another_collection")

qdrant-landing/content/documentation/concepts/indexing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ client.create_payload_index(
182182
```
183183

184184
```typescript
185-
import { QdrantClient, Schemas } from "@qdrant/js-client-rest";
185+
import { QdrantClient } from "@qdrant/js-client-rest";
186186

187187
const client = new QdrantClient({ host: "localhost", port: 6333 });
188188

@@ -379,7 +379,7 @@ client.create_payload_index(
379379
```
380380

381381
```typescript
382-
import { QdrantClient, Schemas } from "@qdrant/js-client-rest";
382+
import { QdrantClient } from "@qdrant/js-client-rest";
383383

384384
const client = new QdrantClient({ host: "localhost", port: 6333 });
385385

qdrant-landing/content/documentation/concepts/payload.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1386,7 +1386,7 @@ var client = new QdrantClient("localhost", 6334);
13861386
await client.FacetAsync(
13871387
"{collection_name}",
13881388
key: "size",
1389-
filter: MatchKeyword("color", "red"),
1389+
filter: MatchKeyword("color", "red")
13901390
);
13911391
```
13921392

qdrant-landing/content/documentation/concepts/points.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1367,7 +1367,7 @@ client.delete_vectors(
13671367
```typescript
13681368
client.deleteVectors("{collection_name}", {
13691369
points: [0, 3, 10],
1370-
vectors: ["text", "image"],
1370+
vector: ["text", "image"],
13711371
});
13721372
```
13731373

qdrant-landing/content/documentation/concepts/vectors.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,7 @@ client.upsert("{collection_name}", {
258258
},
259259
},
260260
}
261+
]
261262
});
262263
```
263264

@@ -831,17 +832,16 @@ client.query_points(
831832
```
832833

833834
```typescript
834-
835835
import { QdrantClient } from "@qdrant/js-client-rest";
836836

837837
const client = new QdrantClient({ host: "localhost", port: 6333 });
838838

839839
client.query("{collection_name}", {
840-
"query": [
841-
[-0.013, 0.020, -0.007, -0.111, ...],
842-
[-0.030, -0.055, 0.001, 0.072, ...],
843-
[-0.041, 0.014, -0.032, -0.062, ...]
844-
]
840+
"query": [
841+
[-0.013, 0.020, -0.007, -0.111],
842+
[-0.030, -0.055, 0.001, 0.072],
843+
[-0.041, 0.014, -0.032, -0.062]
844+
]
845845
});
846846
```
847847

@@ -855,9 +855,9 @@ let res = client.query(
855855
QueryPointsBuilder::new("{collection_name}")
856856
.query(VectorInput::new_multi(
857857
vec![
858-
vec![-0.013, 0.020, -0.007, -0.111, ...],
859-
vec![-0.030, -0.055, 0.001, 0.072, ...],
860-
vec![-0.041, 0.014, -0.032, -0.062, ...],
858+
vec![-0.013, 0.020, -0.007, -0.111],
859+
vec![-0.030, -0.055, 0.001, 0.072],
860+
vec![-0.041, 0.014, -0.032, -0.062],
861861
]
862862
))
863863
).await?;

qdrant-landing/content/documentation/guides/administration.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Qdrant exposes administration tools which enable to modify at runtime the behavi
1313

1414
A locking API enables users to restrict the possible operations on a qdrant process.
1515
It is important to mention that:
16+
1617
- The configuration is not persistent therefore it is necessary to lock again following a restart.
1718
- Locking applies to a single node only. It is necessary to call lock on all the desired nodes in a distributed deployment setup.
1819

qdrant-landing/content/documentation/guides/distributed_deployment.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -535,8 +535,7 @@ client.upsert(
535535
```
536536

537537
```typescript
538-
539-
client.upsertPoints("{collection_name}", {
538+
client.upsert("{collection_name}", {
540539
points: [
541540
{
542541
id: 1111,

qdrant-landing/content/documentation/guides/optimize.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ aliases:
1010
Different use cases require different balances between memory usage, search speed, and precision. Qdrant is designed to be flexible and customizable so you can tune it to your specific needs.
1111

1212
This guide will walk you three main optimization strategies:
13+
1314
- High Speed Search & Low Memory Usage
1415
- High Precision & Low Memory Usage
1516
- High Precision & High Speed Search

0 commit comments

Comments
 (0)