Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
minLevel1
maxLevel2
absoluteUrltrue

...

Overview

...

Snap Type

The PostgreSQL - Vector Search Snap is a Read-type Snap.

...

Field Name

Field Type

Description

Label*

 

Default ValuePostgreSQL Vector Search
Example: PostgreSQL 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 Snaps in your pipeline.

 

Schema name

 

Default Value: N/A
Example: VECTOR_DEMO

String/Expression/Suggestion

Specify the schema name for searching for a vector.

Table Namename*

 

Default Value: N/A 
Example: VECTOR_DEMO.BOOKS

String/Expression/Suggestion

Specify the table name for searching for a vector.

Vector Columncolumn*

 

Default Value: N/A
Example: INT_VEC

String/Expression/Suggestion

Specify the vector column name to search.

Where Clauseclause

 

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 Rowsrows

 

Default Value4
Example: 3
Min Value: 1

Integer/Expression

Specify the number of rows the query must return.

 

Distance Functionfunction*

 

Default ValueL2
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 ValueSelected

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 Value0
Example: 3

Integer/Expression

Specify the maximum number of retry attempts the Snap must make if a network failure occurs.

Retry interval (seconds)

 

Default Value0
Example: 3

Integer/Expression

Specify the time period between two successive retry requests.

Snap execution

Default ValueValidate & 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.

...