ExBifrost.Api.Files (ex_bifrost v0.1.0)

API calls for all endpoints tagged Files.

Summary

Functions

delete_file(connection, file_id, provider, opts \\ [])

Delete a file Deletes a file.

get_file_content(connection, file_id, provider, opts \\ [])

Download file content Downloads the content of a file.

list_files(connection, x_model_provider, opts \\ [])

List files Lists files for a provider.

retrieve_file(connection, file_id, provider, opts \\ [])

Retrieve file metadata Retrieves metadata for a specific file.

upload_file(connection, file, purpose, opts \\ [])

Upload a file Uploads a file to be used with batch operations or other features.

Functions

delete_file(connection, file_id, provider, opts \\ [])

@spec delete_file(
  Tesla.Env.client(),
  String.t(),
  ExBifrost.Model.ModelProvider.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.DeleteFile200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Delete a file Deletes a file.

Parameters

connection (ExBifrost.Connection): Connection to server
file_id (String.t): The ID of the file to delete
provider (ModelProvider): The provider of the file
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.DeleteFile200Response.t} on success
{:error, Tesla.Env.t} on failure

get_file_content(connection, file_id, provider, opts \\ [])

@spec get_file_content(
  Tesla.Env.client(),
  String.t(),
  ExBifrost.Model.ModelProvider.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.BifrostError.t()}
  | {:ok, String.t()}
  | {:error, Tesla.Env.t()}

Download file content Downloads the content of a file.

Parameters

connection (ExBifrost.Connection): Connection to server
file_id (String.t): The ID of the file
provider (ModelProvider): The provider of the file
opts (keyword): Optional parameters

Returns

{:ok, String.t} on success
{:error, Tesla.Env.t} on failure

list_files(connection, x_model_provider, opts \\ [])

@spec list_files(Tesla.Env.client(), ExBifrost.Model.ModelProvider.t(), keyword()) ::
  {:ok, ExBifrost.Model.BifrostError.t()}
  | {:ok, ExBifrost.Model.FileListResponse.t()}
  | {:error, Tesla.Env.t()}

List files Lists files for a provider.

Parameters

connection (ExBifrost.Connection): Connection to server
x_model_provider (ModelProvider): Provider to list files for
opts (keyword): Optional parameters
- :purpose (String.t): Filter by purpose
- :limit (integer()): Maximum number of files to return
- :after (String.t): Cursor for pagination
- :order (String.t): Sort order (asc/desc)

Returns

{:ok, ExBifrost.Model.FileListResponse.t} on success
{:error, Tesla.Env.t} on failure

retrieve_file(connection, file_id, provider, opts \\ [])

@spec retrieve_file(
  Tesla.Env.client(),
  String.t(),
  ExBifrost.Model.ModelProvider.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.BifrostError.t()}
  | {:ok, ExBifrost.Model.RetrieveFile200Response.t()}
  | {:error, Tesla.Env.t()}

Retrieve file metadata Retrieves metadata for a specific file.

Parameters

connection (ExBifrost.Connection): Connection to server
file_id (String.t): The ID of the file
provider (ModelProvider): The provider of the file
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.RetrieveFile200Response.t} on success
{:error, Tesla.Env.t} on failure

upload_file(connection, file, purpose, opts \\ [])

@spec upload_file(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, ExBifrost.Model.FileUploadResponse.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Upload a file Uploads a file to be used with batch operations or other features.

Parameters

connection (ExBifrost.Connection): Connection to server
file (String.t):
purpose (String.t):
opts (keyword): Optional parameters
- :provider (ExBifrost.Model.ModelProvider.t):

Returns

{:ok, ExBifrost.Model.FileUploadResponse.t} on success
{:error, Tesla.Env.t} on failure