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 might 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

Type 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.
Learn more about Error handling.

Snap settings

Legend:
  • Expression icon (): Allows using 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 Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • 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 Remove Vector Store File

Example: Remove data set
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 file Checkbox/Expression

Select this checkbox to permanently delete the file.

Default status: Deselected
Snap execution Dropdown list
Choose 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