glopenai - v1.0.0

glopenai/upload

Types

CompleteUploadRequest

</> 
pub type CompleteUploadRequest {
  CompleteUploadRequest(
    part_ids: List(String),
    md5: option.Option(String),
  )
}

Constructors 

  • CompleteUploadRequest(
  part_ids: List(String),
  md5: option.Option(String),
)

CreateUploadRequest

</> 
pub type CreateUploadRequest {
  CreateUploadRequest(
    filename: String,
    purpose: UploadPurpose,
    bytes: Int,
    mime_type: String,
    expires_after: option.Option(file.FileExpirationAfter),
  )
}

Constructors

Upload

</> 
pub type Upload {
  Upload(
    id: String,
    created_at: Int,
    filename: String,
    bytes: Int,
    purpose: UploadPurpose,
    status: UploadStatus,
    expires_at: Int,
    object: String,
    file: option.Option(file.OpenAiFile),
  )
}

Constructors 

  • Upload(
  id: String,
  created_at: Int,
  filename: String,
  bytes: Int,
  purpose: UploadPurpose,
  status: UploadStatus,
  expires_at: Int,
  object: String,
  file: option.Option(file.OpenAiFile),
)

    Arguments

    file

    Set once the upload is completed and the underlying file is ready.

UploadPart

</> 
pub type UploadPart {
  UploadPart(
    id: String,
    created_at: Int,
    upload_id: String,
    object: String,
  )
}

Constructors 

  • UploadPart(
  id: String,
  created_at: Int,
  upload_id: String,
  object: String,
)

UploadPurpose

</> 
pub type UploadPurpose {
  UploadAssistants
  UploadVision
  UploadBatch
  UploadFineTune
}

Constructors 

  • UploadAssistants
  • UploadVision
  • UploadBatch
  • UploadFineTune

UploadStatus

</> 
pub type UploadStatus {
  UploadPending
  UploadCompleted
  UploadCancelled
  UploadExpired
}

Constructors 

  • UploadPending
  • UploadCompleted
  • UploadCancelled
  • UploadExpired

Values

add_part_request

</> 
pub fn add_part_request(
  config: config.Config,
  upload_id: String,
  data: BitArray,
  boundary: String,
) -> request.Request(BitArray)

Build the multipart add part request. data is the raw chunk bytes; boundary must not appear in data (pick a long random string or hash).

add_part_response

</> 
pub fn add_part_response(
  response: response.Response(String),
) -> Result(UploadPart, error.GlopenaiError)

cancel_request

</> 
pub fn cancel_request(
  config: config.Config,
  upload_id: String,
) -> request.Request(String)

cancel_response

</> 
pub fn cancel_response(
  response: response.Response(String),
) -> Result(Upload, error.GlopenaiError)

complete_request

</> 
pub fn complete_request(
  config: config.Config,
  upload_id: String,
  request: CompleteUploadRequest,
) -> request.Request(String)

complete_response

</> 
pub fn complete_response(
  response: response.Response(String),
) -> Result(Upload, error.GlopenaiError)

complete_upload_request_to_json

</> 
pub fn complete_upload_request_to_json(
  request: CompleteUploadRequest,
) -> json.Json

create_request

</> 
pub fn create_request(
  config: config.Config,
  request: CreateUploadRequest,
) -> request.Request(String)

create_response

</> 
pub fn create_response(
  response: response.Response(String),
) -> Result(Upload, error.GlopenaiError)

create_upload_request_to_json

</> 
pub fn create_upload_request_to_json(
  request: CreateUploadRequest,
) -> json.Json

new_complete_request

</> 
pub fn new_complete_request(
  part_ids: List(String),
) -> CompleteUploadRequest

new_create_request

</> 
pub fn new_create_request(
  filename: String,
  purpose: UploadPurpose,
  bytes: Int,
  mime_type: String,
) -> CreateUploadRequest

upload_decoder

</> 
pub fn upload_decoder() -> decode.Decoder(Upload)

upload_part_decoder

</> 
pub fn upload_part_decoder() -> decode.Decoder(UploadPart)

upload_purpose_decoder

</> 
pub fn upload_purpose_decoder() -> decode.Decoder(UploadPurpose)

upload_purpose_to_json

</> 
pub fn upload_purpose_to_json(
  purpose: UploadPurpose,
) -> json.Json

upload_status_decoder

</> 
pub fn upload_status_decoder() -> decode.Decoder(UploadStatus)

with_expires_after

</> 
pub fn with_expires_after(
  request: CreateUploadRequest,
  expires_after: file.FileExpirationAfter,
) -> CreateUploadRequest

with_md5

</> 
pub fn with_md5(
  request: CompleteUploadRequest,
  md5: String,
) -> CompleteUploadRequest
✨ Search Document