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.


OpenAI List Vector Store Files Snap Overview

Prerequisites

Known issues

  • Although 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.

Snap views

Type 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
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 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 - Ascending order
  • desc - Descending order
If left blank, the default value of the endpoint desc is used.

Default value: N/A

Example: asc
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
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: Validate & Execute

Example: Execute only

Troubleshooting

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.

Examples