...
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Overview
You can use this Snap to perform advanced vector-based queries using the SELECT statement.
Overvie
...
Snap Type
The PostgreSQL - Vector Search Snap is a Read-type Snap.
...
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 in 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
Info |
---|
|
Field Name | Field Type | Description |
---|---|---|
Label*
Default Value: PostgreSQL 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 Snaps 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 theSQL standard, you cannot use the |
Limit Rows
Default Value: 4 | Integer/Expression | Specify the number of rows the query must return.
|
Distance Function*
Default Value: L2 | Dropdown List | Choose the similarity function to compare vectors. The available options are:
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.
|
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 does not return any returns no results.. |
Number of retries
Default Value: 0 | Integer/Expression | Specify the maximum number of retry attempts the Snap must make in case of if a network failure occurs. |
Retry interval (seconds)
Default Value: 0 | Integer/Expression | Specify the time interval period between two successive retry requests. |
Snap execution Default Value: Validate & Execute | Dropdown list | Select one of the following three modes in which the Snap executes:
|
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.
...
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 2nd second match.
...
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
...