Class OpenAIFiles

Hierarchy

Constructors

constructor

Methods

toJSON toJSONNotImplemented createFile deleteFile listFiles retrieveFile retrieveFileContent

Constructors

constructor

Methods

toJSON

toJSONNotImplemented

Static createFile

  • Upload file Upload a file that can be used across various endpoints. The size of all the files uploaded by one organization can be up to 100 GB.

    The size of individual files can be a maximum of 512 MB. See the Assistants Tools guide to learn more about the types of files supported. The Fine-tuning API only supports .jsonl files.

    Parameters

    Returns Promise<FileObject>

    Link

Static deleteFile

Static listFiles

  • List files Returns a list of files that belong to the user's organization.

    Parameters

    • Optional props: {
          options?: RequestOptions;
          query?: FileListParams;
      }
      • Optional options?: RequestOptions
      • Optional query?: FileListParams

    Returns Promise<FileObjectsPage>

    Link

Static retrieveFile

  • Retrieve file Returns information about a specific file.

    Parameters

    • fileId: {
          fileId: string;
      }
      • fileId: string

    Returns Promise<FileObject>

    Link

Static retrieveFileContent

  • Retrieve file content Returns the contents of the specified file.

    Parameters

    • fileId: {
          fileId: string;
      }
      • fileId: string

    Returns Promise<string>

    Note

    You can't retrieve the contents of a file that was uploaded with the "purpose": "assistants" API.

    Link

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc