OpenAI List Vector Store Files

Overview

You can use this Snap to retrieve and list all vector store files using the specified vector store ID.

Prerequisites

An active vector store to use with the Snap. Learn how to Create and configure an OpenAI Vector Store.

Known issues

OpenAI documentation states that cancelled is a supported value for the Filter field; however, using this value may result in an status code 400 error from the endpoint. Workaround: Use only the following supported values - completed, in_progress, and failed.

Limitations

None.


View	Description	Examples of upstream and downstream Snaps
Input	This Snap has at the most one document input view. The required vector store ID to retrieve the files.	Mapper
Output	This Snap has exactly one document output view. The Snap displays the vector store file details associated with the specifed vector store using the List vector store files API.	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 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.

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 (): Indicates that you can add fields in the field set.
Remove 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 List Vector Store Files Example: Company names list
Vector store ID	String/Expression/Suggestion	Required. Specify the ID of the vector store. Default value: N/A Example: vs_XYZ12345ABCDTest123
Order	String/Expression/Suggestion	Specify the sorting order for the files by the creation timestamp. Available options include: `asc` - for ascending order `desc` - for descending order If left blank, the default value of the endpoint `desc` is used by the endpoint. Default value: N/A Example: desc
Filter	String/Expression/Suggestion	Specify the file status for filtering. Available options include: `in_progress` `completed` `failed` Default value: N/A Example: completed
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: Validate & Execute Example: Execute only

Request encountered an error while connecting to OpenAI, status code 400

Invalid value cancelled for the Filter field. Supported values are: completed, in_progress, and failed.

Use only the supported values.