Class Files

constructor

• new Files(client): OpenAIClient.Containers.Files

• Parameters

  • client: OpenAIClient

  Returns OpenAIClient.Containers.Files

content

create

• create(containerID, body, options?): APIPromise<FileCreateResponse>

• Create a Container File

  You can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID.

  Parameters

  • containerID: string
  • body: OpenAIClient.Containers.Files.FileCreateParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<FileCreateResponse>

delete

• delete(fileID, params, options?): APIPromise<void>

• Delete Container File

  Parameters

  • fileID: string
  • params: OpenAIClient.Containers.Files.FileDeleteParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<void>

list

• list(containerID, query?, options?): PagePromise<FileListResponsesPage, FileListResponse>

• List Container files

  Parameters

  • containerID: string
  • Optionalquery: null | OpenAIClient.Containers.Files.FileListParams
  • Optionaloptions: RequestOptions

  Returns PagePromise<FileListResponsesPage, FileListResponse>

retrieve

• retrieve(fileID, params, options?): APIPromise<FileRetrieveResponse>

• Retrieve Container File

  Parameters

  • fileID: string
  • params: OpenAIClient.Containers.Files.FileRetrieveParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<FileRetrieveResponse>