Skip to content

Commit 6e5a377

Browse files
Update README.md
1 parent efa0b2a commit 6e5a377

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ client.objects.batch_delete(
167167

168168
### Querying
169169

170-
#### Get
170+
#### Get{}
171171
```ruby
172172
near_text = '{ concepts: ["biology"] }'
173173
sort_obj = '{ path: ["category"], order: desc }'
@@ -205,7 +205,7 @@ client.query.get class_name: 'Question', fields: 'answer question category _addi
205205

206206
```
207207

208-
#### Aggs
208+
#### Aggs{}
209209
```ruby
210210
client.query.aggs(
211211
class_name: "Question",
@@ -216,7 +216,7 @@ client.query.aggs(
216216
)
217217
```
218218

219-
#### Explore
219+
#### Explore{}
220220
```ruby
221221
client.query.explore(
222222
fields: 'className',
@@ -227,36 +227,42 @@ client.query.explore(
227227

228228
### Classification
229229
```ruby
230+
# Start a classification
230231
client.classifications.create(
231232
type: "zeroshot",
232233
class_name: "Posts",
233234
classify_properties: ["hasColor"],
234235
based_on_properties: ["text"]
235236
)
236237

238+
# Get the status, results and metadata of a previously created classification
237239
client.classifications.get(
238240
id: ""
239241
)
240242
```
241243

242244
### Backups
243245
```ruby
246+
# Create backup
244247
client.backups.create(
245248
backend: "filesystem",
246249
id: "my-first-backup",
247250
include: ["Question"]
248251
)
249252

253+
# Get the backup
250254
client.backups.get(
251255
backend: "filesystem",
252256
id: "my-first-backup"
253257
)
254258

259+
# Restore backup
255260
client.backups.restore(
256261
backend: "filesystem",
257262
id: "my-first-backup"
258263
)
259264

265+
# Check the backup restore status
260266
client.backups.restore_status(
261267
backend: "filesystem",
262268
id: "my-first-backup"
@@ -270,7 +276,12 @@ client.nodes
270276

271277
### Health
272278
```ruby
279+
# Live determines whether the application is alive. It can be used for Kubernetes liveness probe.
273280
client.live?
281+
```
282+
283+
```ruby
284+
# Live determines whether the application is ready to receive traffic. It can be used for Kubernetes readiness probe.
274285
client.ready?
275286
```
276287

0 commit comments

Comments
 (0)