Input 

Document

• Min: 1

• Max: 1

• Join

• JSON Generator

Requires the MongoDB aggregate command to perform vector search.

Output

Document

• Min: 1

• Max: 1

• Mapper

• Copy

Retrieves query results from the collection as specified in the settings.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab:

• Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

• Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

• Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Label*

Default Value: MongoDB - Atlas Vector Search
Example: Atlas Vector Search

String

Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Database name

Default Value: N/A
Example: chunking_strategy

String/Expression/Suggestion

Specify the database where the query is executed. If you do not specify, the database configured in the account is used.

Collection name*

Default Value: N/A
Example: chunk_metadata

String/Expression/Suggestion

Specify or select a MongoDB collection name to find indexes for vector search.

Search index*

Default Value: N/A
Example: vector_index

String/Expression/Suggestion

Specify the name of the vector search index to query. Alternatively, click the Suggestions icon to select the vector search index.

Vector field*

Default Value: N/A
Example: embedding

String/Expression/Suggestion

Specify the name of the vector field that you want to search.

Number of candidates*

Default Value: 100
Example: 50

Integer/Expression

Specify the number of candidates for vector search.

Maximum value: 10000
Minimum value: 0

Limit*

Default Value: 4
Example: 10

Integer/Expression

Specify the number of results to return for each query.

Maximum value: 10000
Minimum value: 0

Advanced settings

Configure the advanced settings as required.

Batch size*

Default Value: 0
Example: 10

Integer

Specify the number of documents to return per batch.

Timezone hours offset

Default Value: 0
Example: 12

Integer

Specify the time zone hour offset to apply to all DateTime fields.

Timezone minutes offset

Default Value: 0
Example: 1

Integer

Specify the time zone minutes offset to apply to all DateTime fields.

Number of retries

Default Value: 0
Example: 4

Integer/Expression

Specify the maximum number of attempts to be made to receive a response. The request is terminated if the attempts do not result in a response.

Retry interval (seconds)

Default Value: 1
Example: 5

Integer/Expression

Specify the time interval between two retry requests.

Snap Execution

Default Value: 
Example: Validate & Execute

Dropdown list

Select one of the following three modes in which the Snap executes:

• Validate & Execute: Performs limited execution of the Snap, and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.

• Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.

• Disabled: Disables the Snap and all Snaps that are downstream from it.

The vector search operation failed.

The specified vector might be invalid.

Specify a valid vector and retry.

Unable to process the input document.

The input document might be invalid.

Specify valid input and retry.

The collection provided cannot be found.

The specified collection is not available.

Specify a valid collection and retry.

The index is not specified.

The index field is mandatory.

Specify a valid index and retry.

The input document does not have a 'vector' specified in the structure.

The input document must have a valid vector.

Add the vector to query the input document and retry.

• Unable to retrieve index fields, OR

• No indexes were found querying database <name>, OR

• Command failed with error 8000 (AtlasError)

Unrecognized pipeline stage <name-of-the-pipeline>.

Ensure the cluster runs on MongoDB Atlas and has a cluster tier of at least M10. Additionally, confirm that the user has the required permissions to access the search index.