S3 Vector Store
Amazon S3 Vector Store uses AWS S3 as a persistent storage backend for vector embeddings, enabling scalable and durable similarity search.
Categories: Artificial Intelligence
Type: s3VectorStore/v1
Connections
Version: 1
custom
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| accessKeyId | Access Key ID | STRING | AWS access key ID for authentication. | true |
| secretAccessKey | Secret Access Key | STRING | AWS secret access key for authentication. | true |
| region | Region | STRING Optionsus-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, ap-east-1, ap-south-1, ap-south-2, ap-northeast-3, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-4, ap-northeast-1, me-south-1, me-central-1, eu-central-1, eu-central-2, eu-west-1, eu-west-2, eu-south-1, eu-south-2, eu-west-3, eu-north-1, af-south-1, sa-east-1, cn-north-1, cn-northwest-1 | AWS region where the S3 bucket is located. | true |
| bucketName | Bucket Name | STRING | The name of the S3 bucket where the vector store data is persisted. | true |
| key | Key | STRING | The S3 object key (file path) used to store the vector store JSON data. | true |
Actions
Load Data
Name: load
Loads data into the vector store using LLM embeddings.
Example JSON Structure
{
"label" : "Load Data",
"name" : "load",
"type" : "s3VectorStore/v1/load"
}Output
This action does not produce any output.
Search Data
Name: search
Query data from the vector store using LLM embeddings.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| query | Query | STRING | The query to be executed. | true |
| topK | Top K | INTEGER | The top 'k' similar results to return. | false |
| similarityThreshold | Similarity Threshold | NUMBER | Similarity threshold score to filter the search response by. Only documents with similarity score equal or greater than the threshold will be returned. A threshold value of 0 means any similarity is accepted. A threshold value of 1 means an exact match is required. | false |
Example JSON Structure
{
"label" : "Search Data",
"name" : "search",
"parameters" : {
"query" : "",
"topK" : 1,
"similarityThreshold" : 0.0
},
"type" : "s3VectorStore/v1/search"
}Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
How is this guide?
Last updated on