Class OpenAIFiles

Hierarchy (view full)

Constructors

constructor

Methods

createFile deleteFile listFiles retrieveFile retrieveFileContent

Constructors

constructor

Methods

createFile

  • createFile(__namedParameters): Promise<FileObject>

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

    Parameters

    • __namedParameters: FileCreateParams & {
          options?: RequestOptions;
      }

    Returns Promise<FileObject>

    Note

    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.

    Link

deleteFile

  • deleteFile(__namedParameters): Promise<FileDeleted>

  • Delete a file.

    Parameters

    • __namedParameters: {
          fileId: string;
          options?: RequestOptions;
      }
      • fileId: string
      • Optional options?: RequestOptions

    Returns Promise<FileDeleted>

    Link

listFiles

  • listFiles(props?): Promise<FileObjectsPage>

  • 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

retrieveFile

  • retrieveFile(__namedParameters): Promise<FileObject>

  • Retrieve file Returns information about a specific file.

    Parameters

    • __namedParameters: {
          fileId: string;
          options?: RequestOptions;
      }
      • fileId: string
      • Optional options?: RequestOptions

    Returns Promise<FileObject>

    Link

retrieveFileContent

  • retrieveFileContent(__namedParameters): Promise<string>

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

    Parameters

    • __namedParameters: {
          fileId: string;
          options?: RequestOptions;
      }
      • fileId: string
      • Optional options?: RequestOptions

    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