OpenAI List Files
Overview
You can use this Snap to retrieve and lists all files associated with the your OpenAI account storage.
- Read-type Snap
- Works in Ultra Tasks
Prerequisites
None.
Limitations and known issues
None.
Snap views
View | Description | Examples of upstream and downstream Snaps |
---|---|---|
Input | This Snap has at the most one document input view. The entity from which you want to read the objects. | Mapper |
Output | This Snap has exactly one document output view. The Snap displays records from the specified purpose and if not specified it lists out all the files of all purposes. It outputs at most 10,000 files. Learn more. | 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:
Learn more about Error handling in Pipelines. |
Snap settings
- 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 Files Example: Company names list |
Purpose | String/Expression/Suggestion | Specify the intended purpose of the file you want to retrieve. If left blank, the Snap retrieves all files associated with your account. It outputs at most 10,000 files. Learn more. Default value: N/A Example: assistants |
Snap execution | Dropdown list |
Select one of the three modes in which the Snap executes.
Available options are:
Default value: Validate & Execute Example: Execute only |
Troubleshooting
Request encountered an error while connecting to OpenAI, status code 400
Invalid Purpose specfied. Expected file Purpose to be one of - assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, and vision.
Use one of the supported file purposes.