View Source ExOpenAI.Components.CreateUploadRequest (ex_openai.ex v2.0.0-beta2)

Module for representing the OpenAI schema CreateUploadRequest.

Fields

  • :bytes - required - integer()
    The number of bytes in the file you are uploading.

  • :expires_after - optional - ExOpenAI.Components.FileExpirationAfter.t()

  • :filename - required - String.t()
    The name of the file to upload.

  • :mime_type - required - String.t()
    The MIME type of the file.

This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.

  • :purpose - required - :assistants | :batch | :"fine-tune" | :vision
    The intended purpose of the uploaded file.

See the documentation on File purposes.
Allowed values: "assistants", "batch", "fine-tune", "vision"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.CreateUploadRequest{
  bytes: integer(),
  expires_after: ExOpenAI.Components.FileExpirationAfter.t() | nil,
  filename: String.t(),
  mime_type: String.t(),
  purpose: ((:assistants | :batch) | :"fine-tune") | :vision
}