Skip to content

Commit 58bff36

Browse files
authored
docs: Rephrase README.md (#46)
1 parent 686d0bd commit 58bff36

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ QdrantClient client =
7171

7272
which creates a client that will connect to Qdrant on <https://localhost:6334>.
7373

74-
Internally, the high level client uses a low level gRPC client to interact with
74+
Internally, the high-level client uses a low-level gRPC client to interact with
7575
Qdrant. Additional constructor overloads provide more control over how the gRPC
7676
client is configured. The following example configures a client to use TLS,
7777
validating the certificate using the root CA to verify the server's identity
@@ -95,7 +95,7 @@ The client implements [`AutoCloseable`](https://docs.oracle.com/javase/8/docs/ap
9595
though a client will typically be created once and used for the lifetime of the
9696
application. When a client is constructed by passing a `ManagedChannel`, the
9797
client does not shut down the channel on close by default. The client can be
98-
configured to shut down the channel on close with
98+
configured to shut down the channel on closing with
9999

100100
```java
101101
ManagedChannel channel = Grpc.newChannelBuilder(
@@ -116,7 +116,7 @@ All client methods return `ListenableFuture<T>`.
116116
Once a client has been created, create a new collection
117117

118118
```java
119-
client.createCollectionAsync("my_collection",
119+
client.createCollectionAsync("{collection_name}",
120120
VectorParams.newBuilder()
121121
.setDistance(Distance.Cosine)
122122
.setSize(4)
@@ -152,17 +152,17 @@ List<PointStruct> points =
152152
"extra_field", value(true)))
153153
.build());
154154

155-
UpdateResult updateResult = client.upsertAsync("my_collection", points).get();
155+
UpdateResult updateResult = client.upsertAsync("{collection_name}", points).get();
156156
```
157157

158158
Search for similar vectors
159159

160160
```java
161-
List<ScoredPoint> anush =
161+
List<ScoredPoint> points =
162162
client
163163
.searchAsync(
164164
SearchPoints.newBuilder()
165-
.setCollectionName("my_collection")
165+
.setCollectionName("{collection_name}")
166166
.addAllVector(List.of(0.6235f, 0.123f, 0.532f, 0.123f))
167167
.setLimit(5)
168168
.build())
@@ -176,7 +176,7 @@ Search for similar vectors with filtering condition
176176
import static io.qdrant.client.ConditionFactory.range;
177177

178178
List<ScoredPoint> points = client.searchAsync(SearchPoints.newBuilder()
179-
.setCollectionName("my_collection")
179+
.setCollectionName("{collection_name}")
180180
.addAllVector(List.of(0.6235f, 0.123f, 0.532f, 0.123f))
181181
.setFilter(Filter.newBuilder()
182182
.addMust(range("rand_number", Range.newBuilder().setGte(3).build()))

0 commit comments

Comments
 (0)