Input 

Document

• Min: 1

• Max: 1

• Mapper

• Copy

• Requires an input vector with the same dimension as the selected vector column.

• Requires a vector input with an array of float/int data types.

Output

Document

• Min: 1

• Max: 1

• Mapper

• Copy

For each input document, all results are grouped into a single output document.

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: AlloyDB Vector Search
Example: AlloyDB VS

String

Specify a 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.

Schema name

Default Value: N/A
Example: VECTOR_DEMO

String/Expression/Suggestion

Specify the schema name when searching for a vector.

Table Name*

Default Value: N/A 
Example: VECTOR_DEMO.BOOKS

String/Expression/Suggestion

Specify the table name when searching for a vector.

Vector Column*

Default Value: N/A
Example: INT_VEC

String/Expression/Suggestion

Specify the vector column name to search.

Where Clause

Default Value: N/A
Example: ID > '001i0000007FVjpAAG'

String/Expression/Suggestion

Specify the where clause to use in the vector search query statement.

Limit Rows

Default Value: 4
Example: 3
Min Value: 1

Integer/Expression/Suggestion

Specify the number of results to return for each query.

Distance Function*

Default Value: L2
Example: COSINE

Dropdown List

Choose the similarity function to compare vectors. The available options are:

• L2: (Euclidean Distance) Measures the straight-line distance between two points. It’s useful when you want to calculate the "as-the-crow-flies" distance.

• L1: (Manhattan Distance) Measures the distance between two points along the axes at right angles. It’s useful in grid-based systems, like city streets.

• COSINE: Measures the cosine of the angle between two vectors. It is commonly used in high-dimensional positive spaces to assess similarity irrespective of magnitude.

• Inner Product: (Dot Product) Measures the similarity between two vectors. It’s useful in various applications, such as calculating the angle between vectors or finding projections.

Learn more about the Vector Similarity Functions.

Include vector values

Default Value: Deselected

Checkbox/Expression

Select this checkbox to include vector values in the response.

Include scores

Default Value: Selected

Checkbox/Expression

Select this checkbox to include similarity scores in the response.

Ignore empty result

Default Value: Deselected

Checkbox

Select this checkbox if you want the Snap to produce no output when no matching vector is found. Otherwise, the Snap outputs a blank document when there are no matching vectors.

Number of retries

Default Value: 0
Example: 3

Integer/Expression

Specify the maximum number of attempts to be made to receive a response.

Retry interval (seconds)

Default Value: 0
Example: 3

Integer/Expression

Specify the minimum number of seconds the Snap must wait before each retry attempt.

Snap execution

Default Value: Validate & Execute
Example: Execute only

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.