OpenAI Create Vector Store

Overview

You can use this Snap to create a vector store for storing and managing vector embeddings generated from OpenAI models. You can configure advanced options, such as file IDs, expiration time, and chunking strategies to optimize storage and retrieval efficiency.


OpenAI Create Vector Store Snap Overview

Prerequisites

None

Known issues

None.

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap supports a maximum of one document input view. Mapper
Output This Snap has a maximum of one document output view. The Snap provides the details of the created vector store, such as vector store ID and metadata. Mapper
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. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when an error occurs.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining records.
  • Route Error Data to Error View Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap settings

Legend:
  • Expression icon (): JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Account configuration.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field / field set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: OpenAI Create Vector Store

Example: Create customer embeddings vector store
Name String/Expression

Specify the name of the vector store to be created.

Default value: N/A

Example: SemanticSearchVectorStore
Advanced configuration Use this field set to configure files that are being processed.
File IDs Use this field set to list the file IDs to be used by the vector store during creation.
File ID String/Expression

Specify the ID of the file to be included in the vector store.

Default value: N/A

Example: file-123ABC456DEF789GHIJKL
Expires after (days) Integer/Expression

Specify the number of days after the vector store creation time that the vector store will expire.

Minimum value: 1

Maximum value: 365

Default value: N/A

Example: 7
Chunking strategy Configure the chunking strategy to divide data into manageable vector embeddings.
Important: Ensure both Max chunk size tokens and Chunk overlap tokens are either null or non-null.
Max chunk size tokens Integer/Expression
Specify the maximum number of tokens in each chunk.
Tip: This field must either be configured or left blank to avoid an error.
Minimum value: 100

Maximum value: 4096

Default value: 800

Example: 120
Chunk overlap tokens Integer/Expression
Specify the number of tokens to overlap between chunks..
Tip:
  • This field must either be configured or left blank to avoid an error.
  • Ensure the Chunk overlap tokens is no more than half of the Max chunk size tokens.
Default value: 400

Example: 50
Metadata String/Expression Secify the metadata that provides additional information to facilitate efficient search and filtering is stored in a structured format.
Important:
  • Supports up to 16 key-value pairs attached to an object.
  • Keys can be a maximum of 64 characters long.
  • Values can be a maximum of 512 characters long.
  • If the value is not a string, it will be automatically stringified.

Default value: N/A

Example: { "fileType": "PDF", "department": "Marketing" }
Snap execution Dropdown list
Select one of the three modes in which the Snap executes. Available options are:
  • 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.

Default value: Execute only

Example: Validate and Execute

Examples