Skip to content

Commit 339b357

Browse files
committed
Add parameter descriptions
1 parent 7d40750 commit 339b357

File tree

8 files changed

+155
-76
lines changed

8 files changed

+155
-76
lines changed

generator/config/stage/search.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,58 +12,83 @@ arguments:
1212
name: operator
1313
type:
1414
- searchOperator
15+
description: |
16+
Operator to search with. You can provide a specific operator or use
17+
the compound operator to run a compound query with multiple operators.
1518
-
1619
name: index
1720
optional: true
1821
type:
1922
- string
23+
description: |
24+
Name of the Atlas Search index to use. If omitted, defaults to default.
2025
-
2126
name: highlight
2227
optional: true
2328
type:
2429
# @todo support "highlight" type object
2530
# https://www.mongodb.com/docs/atlas/atlas-search/highlighting/
2631
- object
32+
description: |
33+
Specifies the highlighting options for displaying search terms in their original context.
2734
-
2835
name: concurrent
2936
optional: true
3037
type:
3138
- bool
39+
description: |
40+
Parallelize search across segments on dedicated search nodes.
41+
If you don't have separate search nodes on your cluster,
42+
Atlas Search ignores this flag. If omitted, defaults to false.
3243
-
3344
name: count
3445
optional: true
3546
type:
3647
- string
48+
description: |
49+
Document that specifies the count options for retrieving a count of the results.
3750
-
3851
name: searchAfter
3952
optional: true
4053
type:
4154
- string
55+
description: |
56+
Reference point for retrieving results. searchAfter returns documents starting immediately following the specified reference point.
4257
-
4358
name: searchBefore
4459
optional: true
4560
type:
4661
- string
62+
description: |
63+
Reference point for retrieving results. searchBefore returns documents starting immediately following the specified reference point.
4764
-
4865
name: scoreDetails
4966
optional: true
5067
type:
5168
- bool
69+
description: |
70+
Flag that specifies whether to retrieve a detailed breakdown of the score for the documents in the results. If omitted, defaults to false.
5271
-
5372
name: sort
5473
optional: true
5574
type:
5675
- object
76+
description: |
77+
Document that specifies the fields to sort the Atlas Search results by in ascending or descending order.
5778
-
5879
name: returnStoredSource
5980
optional: true
6081
type:
6182
- bool
83+
description: |
84+
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.
6285
-
6386
name: tracking
6487
optional: true
6588
type:
6689
- object
90+
description: |
91+
Document that specifies the tracking option to retrieve analytics information on the search terms.
6792
tests:
6893
-
6994
name: 'Example'

generator/config/stage/searchMeta.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,24 @@ arguments:
1212
name: operator
1313
type:
1414
- searchOperator
15+
description: |
16+
Operator to search with. You can provide a specific operator or use
17+
the compound operator to run a compound query with multiple operators.
1518
-
1619
name: index
1720
optional: true
1821
type:
1922
- string
23+
description: |
24+
Name of the Atlas Search index to use. If omitted, defaults to default.
25+
2026
-
2127
name: count
2228
optional: true
2329
type:
2430
- object
31+
description: |
32+
Document that specifies the count options for retrieving a count of the results.
2533
tests:
2634
-
2735
name: 'Example'

generator/config/stage/vectorSearch.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,33 +11,47 @@ arguments:
1111
name: index
1212
type:
1313
- string
14+
description: |
15+
Name of the Atlas Vector Search index to use.
1416
-
1517
name: limit
1618
type:
1719
- int
20+
description: |
21+
Number of documents to return in the results. This value can't exceed the value of numCandidates if you specify numCandidates.
1822
-
1923
name: path
2024
type:
2125
- searchPath
26+
description: |
27+
Indexed vector type field to search.
2228
-
2329
name: queryVector
2430
type:
2531
- array # of numbers
32+
description: |
33+
Array of numbers that represent the query vector. The number type must match the indexed field value type.
2634
-
2735
name: exact
2836
optional: true
2937
type:
3038
- bool
39+
description: |
40+
This is required if numCandidates is omitted.
41+
- false to run ANN search
42+
- true to run ENN search
3143
-
3244
name: filter
3345
optional: true
3446
type:
3547
- query
48+
description: |
3649
-
3750
name: numCandidates
3851
optional: true
3952
type:
4053
- int
54+
description: |
4155
tests:
4256
-
4357
name: 'ANN Basic'

src/Builder/Stage/FactoryTrait.php

Lines changed: 25 additions & 19 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: 25 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/Builder/Stage/SearchMetaStage.php

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

0 commit comments

Comments
 (0)