In this article

Overview

...

Overvie

...

Snap Type

The <Snap name> PostgreSQL - Vector Search Snap is a Read/Write/Parse/Transform/Flow/Format-type Snap that reads/fetches/writes/parses/executes/transforms/calls/creates… .

Prerequisites

...

Valid client ID.

A valid account with the required permissions

...

None.

Support for Ultra Pipelines

...

Works in Ultra Pipelines. 

...

Works in Ultra Pipelines if....

...

Does not support Ultra Pipelines. 

Limitations

None.

Limitations and Known Issues

None.

Snap Views

Snap Settings

...

**Delete Before Publishing**

Choose from the following sentences to document specific field types.

Drop-down lists/Option Buttons (radio buttons):

You must list the LoV and describe them if their meaning isn't apparent. In this case, format the LoV in italics, regular font for the LoV's description. In either case, list the LoVs as a bullet list.

• <State what the option should do in this field>. The available options are: <bullet list of LoVs>
  Specify the Salesforce API to be used. The available options are:...

• Select the <category> that you want to use. Available options are...
  * Option 1<italicized>. <third person singular form of the verb>
  * Option 2<italicized>. <third person singular form of the verb>
  Select the API that you want to use. Available options are:
  Bulk API. Sends the Snap execution request details as a bulk API call.
  REST API. ...
  OR
  Select one of the three following modes in which the Snap executes:
  * Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then 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 downstream from it.
  

Check boxes:

...

If selected, <Snap behavior>.
If selected, an empty file is written when the incoming document has no data.

...

Use "If not selected" if the first sentence is long.
If selected, the Snap uses the file path value as is. Otherwise, the Snap uses the file path value in the URL.
If selected, an empty file is written when the incoming document has empty data. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property.

Select to <action>
Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
Select to execute the Pipeline during validation.

Text Fields

• Describe what the user shall specify in this field. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
  Enter the name for new account.
  Specify the account ID to use to log in to the endpoint.
  Required if IAM Role is selected.
  Do not use this field if you are using batch processing.
  

Numeric Text Fields

• Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
  The number of records in a batch.
  The number of seconds for which you want the Snap to wait between retries.
  The number of seconds for which the Snap waits between retries.
  Use the following special values:
  * 0: Disables batching.
  * 1: Includes all documents in a single request.

Notes in field descriptions

• Confluence’s new editor does not allow nesting of most macros inside another macro, especially the Note/Alert/Warning/Info (Panel) macros inside a table macro and Excerpt macros inside Expand or Panel Macro+ macros. So, as a workaround use the Footnotes approach as mentioned below:

  • Assign numbers at the Note locations in the form of follow through phrases like See Note 2 below this table. or such.

  • Add your Notes---an appropriate Note/Alert/Warning/Info (Panel) macro---immediately below the macro (for example, Table macro) beginning the content with the corresponding number assigned.

Info

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 fieldsetfield set. Remove icon ( ): Indicates that you can remove fields from the fieldsetfield set. Upload icon ( ): Indicates that you can upload files.

Field Name	Field Type

Field Dependency

	Description
Label*   Default Value:

ELT Database Account

PostgreSQL Vector Search Example:

 ELT RS Account

PostgreSQL VS

String

None.

The

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

Snaps in your pipeline

.

Number of records

Default Value: 
Example:

String/Expression

Sampling Type is Number of records.

Enter the number of records to output.

fieldset Name

Specify advanced parameters that you want to include in the request.

Field 1*

Default Value: <value> or None.
Example: <value>

String

Debug mode check box is not selected.

Field 2

Default Value: <value> or None.
Example: <value>

String

None.

Snap Execution

Default Value: 
Example: Validate & Execute

Dropdown list

N/A

.
Schema name   Default Value: N/A Example: VECTOR_DEMO	String/Expression/Suggestion	Specify the schema name for searching for a vector.
Table Name*   Default Value: N/A  Example: VECTOR_DEMO.BOOKS	String/Expression/Suggestion	Specify the table name for 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. Because of the limitation of theSQL standard, you cannot use the _SL_DISTANCE column in the where clause.
Limit Rows   Default Value: 4 Example: 3 Min Value: 1	Integer/Expression	Specify the number of rows the query must return.
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 on the axes at right angles. It’s useful in grid-based systems, such as, city streets. COSINE: Measures the cosine of the angle between two vectors. It's commonly used in high-dimensional positive spaces to assess similarity regardless 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. 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. This field does not support input schema from the upstream Snaps. When you select this checkbox, the output preview displays _SL_DISTANCE, which is the distance between the input vector and vectors in the database.
Ignore empty result Default Value: Deselected	Checkbox	Select this checkbox to ignore the empty results and not write a document to the output view when a search operation returns no results..
Number of retries   Default Value: 0 Example: 3	Integer/Expression	Specify the maximum number of retry attempts the Snap must make if a network failure occurs.
Retry interval (seconds)   Default Value: 0 Example: 3	Integer/Expression	Specify the time period between two successive retry requests.
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.

Troubleshooting

...

Error

...

Reason

...

Resolution

...

Account validation failed.

...

The Pipeline ended before the batch could complete execution due to a connection error.

...

Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.

Examples

Excluding Fields from the Input Data Stream

We can exclude the unrequired fields from the input data stream by omitting them in the Input schema fieldset. This example demonstrates how we can use the <Snap Name> to achieve this result:

<screenshot of Pipeline/Snap and description>

Download this Pipeline. 

Downloads

Snap Pack History

...

...

Related Content

...

Endpoint Doc Link 1

...

Endpoint Doc Link 2

...

Example

Use Cosine Distance to Find Similar Vectors

The example pipeline below demonstrates how to use the PostgreSQL - Vector Search Snap to find similar vectors using the Cosine distance function.

...

Step 1: Configure the Mapper Snap with a vector to find similar vectors in the PostgreSQL database.

...

Step 2: Configure the PostgreSQL - Vector Search Snap as shown below:

...

Step 3: Validate the pipeline. On validation, the Snap fetches similar vectors based on the following criteria:

• The match vectors have cosine similarity distances, indicating their similarity to the input vector.

• The cosine similarity distances measure how close the match vectors are to the input vector, with values closer to 0, indicating higher similarity.

• The first match has the highest similarity (lowest distance), followed by the second match.

...

Related Content

• Vector Similarity Search for PostgreSQL

• Getting Started with SnapLogic

• Snap Support for Ultra Pipelines