glopenai - v1.0.0

glopenai/file

Types

CreateFileRequest

</>

Parameters for uploading a file. The body is sent as multipart/form-data.

pub type CreateFileRequest {
  CreateFileRequest(
    filename: String,
    file_bytes: BitArray,
    purpose: OpenAiFilePurpose,
    expires_after: option.Option(FileExpirationAfter),
  )
}

Constructors 

  • CreateFileRequest(
  filename: String,
  file_bytes: BitArray,
  purpose: OpenAiFilePurpose,
  expires_after: option.Option(FileExpirationAfter),
)

    Arguments

    filename

    Name attached to the multipart file part. Usually the original filename (e.g. "data.jsonl").

    file_bytes

    Raw file bytes.

    purpose

    What the file will be used for.

DeleteFileResponse

</>

Response from deleting a file.

pub type DeleteFileResponse {
  DeleteFileResponse(id: String, object: String, deleted: Bool)
}

Constructors 

  • DeleteFileResponse(id: String, object: String, deleted: Bool)

FileExpirationAfter

</>

Expiration policy for an uploaded file.

pub type FileExpirationAfter {
  FileExpirationAfter(
    anchor: FileExpirationAfterAnchor,
    seconds: Int,
  )
}

Constructors

FileExpirationAfterAnchor

</>

Anchor timestamp for FileExpirationAfter. Currently only created_at.

pub type FileExpirationAfterAnchor {
  CreatedAt
}

Constructors 

  • CreatedAt

ListFilesResponse

</>

Response from listing files.

pub type ListFilesResponse {
  ListFilesResponse(
    object: String,
    data: List(OpenAiFile),
    first_id: option.Option(String),
    last_id: option.Option(String),
    has_more: Bool,
  )
}

Constructors

OpenAiFile

</>

An OpenAI file object.

pub type OpenAiFile {
  OpenAiFile(
    id: String,
    object: String,
    bytes: Int,
    created_at: Int,
    expires_at: option.Option(Int),
    filename: String,
    purpose: OpenAiFilePurpose,
  )
}

Constructors 

  • OpenAiFile(
  id: String,
  object: String,
  bytes: Int,
  created_at: Int,
  expires_at: option.Option(Int),
  filename: String,
  purpose: OpenAiFilePurpose,
)

OpenAiFilePurpose

</>

The purpose of an uploaded file as reported by the API.

pub type OpenAiFilePurpose {
  Assistants
  AssistantsOutput
  Batch
  BatchOutput
  FineTune
  FineTuneResults
  Vision
  UserData
}

Constructors 

  • Assistants
  • AssistantsOutput
  • Batch
  • BatchOutput
  • FineTune
  • FineTuneResults
  • Vision
  • UserData

Values

content_request

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

Build a request to download the content of a file. The response body contains the raw file content.

content_response

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

Parse the response from downloading file content. Returns the raw body string on success.

create_request

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

Build a POST /files multipart request. The caller chooses boundary; it must not appear inside request.file_bytes.

create_response

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

delete_request

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

Build a request to delete a file.

delete_response

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

Parse the response from deleting a file.

file_expiration_after_anchor_decoder

</> 
pub fn file_expiration_after_anchor_decoder() -> decode.Decoder(
  FileExpirationAfterAnchor,
)

file_expiration_after_anchor_to_json

</> 
pub fn file_expiration_after_anchor_to_json(
  anchor: FileExpirationAfterAnchor,
) -> json.Json

file_expiration_after_decoder

</> 
pub fn file_expiration_after_decoder() -> decode.Decoder(
  FileExpirationAfter,
)

file_expiration_after_to_json

</> 
pub fn file_expiration_after_to_json(
  expiration: FileExpirationAfter,
) -> json.Json

list_request

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

Build a request to list files.

list_response

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

Parse the response from listing files.

new_create_request

</> 
pub fn new_create_request(
  filename: String,
  file_bytes: BitArray,
  purpose: OpenAiFilePurpose,
) -> CreateFileRequest

openai_file_decoder

</> 
pub fn openai_file_decoder() -> decode.Decoder(OpenAiFile)

openai_file_purpose_decoder

</> 
pub fn openai_file_purpose_decoder() -> decode.Decoder(
  OpenAiFilePurpose,
)

openai_file_purpose_to_json

</> 
pub fn openai_file_purpose_to_json(
  purpose: OpenAiFilePurpose,
) -> json.Json

openai_file_to_json

</> 
pub fn openai_file_to_json(file: OpenAiFile) -> json.Json

retrieve_request

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

Build a request to retrieve metadata for a specific file.

retrieve_response

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

Parse the response from retrieving a file.

with_expires_after

</> 
pub fn with_expires_after(
  request: CreateFileRequest,
  expires_after: FileExpirationAfter,
) -> CreateFileRequest
✨ Search Document