OpenAI Remove Vector Store File

Overview

You can use this Snap to remove and choose to permanently delete a file from the specified vector store.


OpenAI Remove Vector Store File Snap Overview

Prerequisites

Known issues

  • This Snap may indicate a successful deletion in the output; however, the file might still appear in the output of the OpenAI List Vector Store Files Snap. This is a known bug from OpenAI. Learn more.

Limitations

None.

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap supports a maximum of one document input view. You must provide vector store and file ID.
Output This Snap has a maximum of one document output view. The Snap provides the removed file details and deletion status if the Delete file checkbox is selected.
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 the Snap encounters an error.
  • 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

Note:
  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
  • Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
  • Add icon (Plus Icon): Indicates that you can add fields in the field set.
  • Remove icon (Minus Icon): Indicates that you can remove fields from the field set.
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 Remove Vector Store File

Example: Remove dataset
Vector store ID String/Expression/Suggestion

Required. Specify the ID of the vector store.

Default value: N/A

Example: vs_XYZ12345ABCDTest123
File ID String/Expression/Suggestion

Required. Specify the ID of the file.

Default value: N/A

Example: file-123ABC456DEF789GHIJKL
Delete fle Checkbox/Expression

Select this checkbox to delete the file permanently.

Default status: Deselected
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 & Execute

Examples