Class OpenAIFiles

constructor

• new OpenAIFiles(fields?: OpenAIFilesInput): OpenAIFiles

  Parameters

  • Optionalfields: OpenAIFilesInput

  Returns OpenAIFiles

lc_namespace

createFile

• createFile(__namedParameters: any): Promise<any>

  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: any

  Returns Promise<any>

  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: { fileId: string; options?: any }): Promise<any>

  Delete a file.

  Parameters

  • __namedParameters: { fileId: string; options?: any }

  Returns Promise<any>

  Link

listFiles

• listFiles(props?: { options?: any; query?: any }): Promise<any>

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

  Parameters

  • Optionalprops: { options?: any; query?: any }

  Returns Promise<any>

  Link

retrieveFile

• retrieveFile(__namedParameters: { fileId: string; options?: any }): Promise<any>

  Retrieve file Returns information about a specific file.

  Parameters

  • __namedParameters: { fileId: string; options?: any }

  Returns Promise<any>

  Link

retrieveFileContent

• retrieveFileContent(
      __namedParameters: { fileId: string; options?: any },
  ): Promise<any>

  Retrieve file content Returns the contents of the specified file.

  Parameters

  • __namedParameters: { fileId: string; options?: any }

  Returns Promise<any>

  Note

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

  Link