Skip to content

Commit e57aa66

Browse files
committed
Review of descriptions
1 parent d5fb819 commit e57aa66

File tree

6 files changed

+36
-50
lines changed

6 files changed

+36
-50
lines changed

generator/config/stage/search.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ arguments:
6161
type:
6262
- string
6363
description: |
64-
Reference point for retrieving results. searchBefore returns documents starting immediately following the specified reference point.
64+
Reference point for retrieving results. searchBefore returns documents starting immediately before the specified reference point.
6565
-
6666
name: scoreDetails
6767
optional: true
@@ -82,7 +82,7 @@ arguments:
8282
type:
8383
- bool
8484
description: |
85-
Flag that specifies whether to return the stored source document in the search results. If omitted, defaults to false.Flag that specifies whether to perform a full document lookup on the backend database or return only stored source fields directly from Atlas Search.
85+
Flag that specifies whether to perform a full document lookup on the backend database or return only stored source fields directly from Atlas Search.
8686
-
8787
name: tracking
8888
optional: true

generator/config/stage/vectorSearch.yaml

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,23 @@ arguments:
3737
type:
3838
- bool
3939
description: |
40-
This is required if numCandidates is omitted.
41-
- false to run ANN search
42-
- true to run ENN search
40+
This is required if numCandidates is omitted. false to run ANN search. true to run ENN search.
4341
-
4442
name: filter
4543
optional: true
4644
type:
4745
- query
4846
description: |
47+
Any match query that compares an indexed field with a boolean, date, objectId, number (not decimals), string, or UUID to use as a pre-filter.
4948
-
5049
name: numCandidates
5150
optional: true
5251
type:
5352
- int
5453
description: |
54+
This field is required if exact is false or omitted.
55+
Number of nearest neighbors to use during the search. Value must be less than or equal to (<=) 10000. You can't specify a number less than the number of documents to return (limit).
56+
5557
tests:
5658
-
5759
name: 'ANN Basic'
@@ -61,11 +63,7 @@ tests:
6163
$vectorSearch:
6264
index: 'vector_index'
6365
path: 'plot_embedding'
64-
queryVector:
65-
- -0.0016261312
66-
- -0.028070757
67-
- -0.011342932
68-
# skip other numbers, not relevant to the test
66+
queryVector: [-0.0016261312, -0.028070757, -0.011342932] # skip other numbers, not relevant to the test
6967
numCandidates: 150
7068
limit: 10
7169
-
@@ -89,11 +87,7 @@ tests:
8987
-
9088
year:
9189
$lt: 1975
92-
queryVector:
93-
- 0.02421053
94-
- -0.022372592
95-
- -0.006231137
96-
# skip other numbers, not relevant to the test
90+
queryVector: [0.02421053, -0.022372592, -0.006231137] # skip other numbers, not relevant to the test
9791
numCandidates: 150
9892
limit: 10
9993
-
@@ -113,11 +107,7 @@ tests:
113107
$vectorSearch:
114108
index: 'vector_index'
115109
path: 'plot_embedding'
116-
queryVector:
117-
- -0.006954097
118-
- -0.009932499
119-
- -0.001311474
120-
# skip other numbers, not relevant to the test
110+
queryVector: [-0.006954097, -0.009932499, -0.001311474] # skip other numbers, not relevant to the test
121111
exact: true
122112
limit: 10
123113
-

src/Builder/Stage/FactoryTrait.php

Lines changed: 6 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/Builder/Stage/FluentFactoryTrait.php

Lines changed: 6 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/Builder/Stage/SearchStage.php

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/Builder/Stage/VectorSearchStage.php

Lines changed: 10 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)