Skip to content

Commit

Permalink
Add parameter descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
GromNaN committed Nov 26, 2024
1 parent 7d40750 commit 339b357
Show file tree
Hide file tree
Showing 8 changed files with 155 additions and 76 deletions.
25 changes: 25 additions & 0 deletions generator/config/stage/search.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,58 +12,83 @@ arguments:
name: operator
type:
- searchOperator
description: |
Operator to search with. You can provide a specific operator or use
the compound operator to run a compound query with multiple operators.
-
name: index
optional: true
type:
- string
description: |
Name of the Atlas Search index to use. If omitted, defaults to default.
-
name: highlight
optional: true
type:
# @todo support "highlight" type object
# https://www.mongodb.com/docs/atlas/atlas-search/highlighting/
- object
description: |
Specifies the highlighting options for displaying search terms in their original context.
-
name: concurrent
optional: true
type:
- bool
description: |
Parallelize search across segments on dedicated search nodes.
If you don't have separate search nodes on your cluster,
Atlas Search ignores this flag. If omitted, defaults to false.
-
name: count
optional: true
type:
- string
description: |
Document that specifies the count options for retrieving a count of the results.
-
name: searchAfter
optional: true
type:
- string
description: |
Reference point for retrieving results. searchAfter returns documents starting immediately following the specified reference point.
-
name: searchBefore
optional: true
type:
- string
description: |
Reference point for retrieving results. searchBefore returns documents starting immediately following the specified reference point.
-
name: scoreDetails
optional: true
type:
- bool
description: |
Flag that specifies whether to retrieve a detailed breakdown of the score for the documents in the results. If omitted, defaults to false.
-
name: sort
optional: true
type:
- object
description: |
Document that specifies the fields to sort the Atlas Search results by in ascending or descending order.
-
name: returnStoredSource
optional: true
type:
- bool
description: |
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.
-
name: tracking
optional: true
type:
- object
description: |
Document that specifies the tracking option to retrieve analytics information on the search terms.
tests:
-
name: 'Example'
Expand Down
8 changes: 8 additions & 0 deletions generator/config/stage/searchMeta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,24 @@ arguments:
name: operator
type:
- searchOperator
description: |
Operator to search with. You can provide a specific operator or use
the compound operator to run a compound query with multiple operators.
-
name: index
optional: true
type:
- string
description: |
Name of the Atlas Search index to use. If omitted, defaults to default.
-
name: count
optional: true
type:
- object
description: |
Document that specifies the count options for retrieving a count of the results.
tests:
-
name: 'Example'
Expand Down
14 changes: 14 additions & 0 deletions generator/config/stage/vectorSearch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,33 +11,47 @@ arguments:
name: index
type:
- string
description: |
Name of the Atlas Vector Search index to use.
-
name: limit
type:
- int
description: |
Number of documents to return in the results. This value can't exceed the value of numCandidates if you specify numCandidates.
-
name: path
type:
- searchPath
description: |
Indexed vector type field to search.
-
name: queryVector
type:
- array # of numbers
description: |
Array of numbers that represent the query vector. The number type must match the indexed field value type.
-
name: exact
optional: true
type:
- bool
description: |
This is required if numCandidates is omitted.
- false to run ANN search
- true to run ENN search
-
name: filter
optional: true
type:
- query
description: |
-
name: numCandidates
optional: true
type:
- int
description: |
tests:
-
name: 'ANN Basic'
Expand Down
44 changes: 25 additions & 19 deletions src/Builder/Stage/FactoryTrait.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

44 changes: 25 additions & 19 deletions src/Builder/Stage/FluentFactoryTrait.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 10 additions & 6 deletions src/Builder/Stage/SearchMetaStage.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 339b357

Please sign in to comment.