In this article
Overview
You can use this Snap to query similar vectors (in the PostgreSQL database) as part of a select statement using Vectors as a data type.
Snap Type
The AlloyDB Vector Search Snap is a Read-type Snap.
Prerequisites
A valid account with the required permissions.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations and Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document
|
|
|
|
Output | Document
|
|
| 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:
Learn more about Error handling in Pipelines. |
Snap Settings
Asterisk ( * ): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the fieldset.
Remove icon ( ): Indicates that you can remove fields from the fieldset.
Upload icon ( ): Indicates that you can upload files.
Field Name | Field Type | Description |
---|---|---|
Label*
Default Value: AlloyDB Vector Search | 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 | String/Expression/Suggestion | Specify the schema name for searching for a vector. |
Table name*
Default Value: N/A | String/Expression/Suggestion | Specify the table name for searching for a vector. |
Vector column*
Default Value: N/A | String/Expression/Suggestion | Specify the vector column name to search. |
Where clause
Default Value: N/A | String/Expression/Suggestion | Specify the where clause to use in the vector search query statement. Because of the limitation of SQL standard, you cannot use the |
Limit rows
Default Value: 4 | Integer/Expression/Suggestion | Specify the number of results to return for each query.
|
Distance function*
Default Value: L2 | Dropdown List | Select the similarity functions used for comparing vectors. The available options are:
Learn more about the Vector Similarity Functions. |
Include values
Default Value: Deselected | Checkbox/Expression | Select this checkbox to include vector values in the response. This field does not support input schema from the upstream Snaps. |
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 there is no matching vector is found. Otherwise, the Snap outputs a blank document when there are no matching vectors. |
Number of retries
Default Value: 0 | Integer/Expression | Specify the maximum number of attempts to be made to receive a response. |
Retry interval (seconds)
Default Value: 0 | Integer/Expression | Specify the minimum number of seconds the Snap must wait before each retry attempt. |
Handle timestamp and date time data
Default Value: Default Date Time format in UTC Time Zone | Dropdown List | Select how you want the Snap to handle timestamp and date time data. The available options are:
|
Snap execution Default Value: Validate & Execute | Dropdown list | Select one of the following three modes in which the Snap executes:
|