ExBifrost.Api.Batch (ex_bifrost v0.1.0)

API calls for all endpoints tagged Batch.

Summary

Functions

cancel_batch(connection, batch_id, provider, opts \\ [])

Cancel a batch job Cancels a batch job.

create_batch(connection, batch_create_request, opts \\ [])

Create a batch job Creates a batch job for asynchronous processing.

get_batch_results(connection, batch_id, provider, opts \\ [])

Get batch results Retrieves results from a completed batch job.

list_batches(connection, provider, opts \\ [])

List batch jobs Lists batch jobs for a provider.

retrieve_batch(connection, batch_id, provider, opts \\ [])

Retrieve a batch job Retrieves a specific batch job by ID.

Functions

cancel_batch(connection, batch_id, provider, opts \\ [])

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

Cancel a batch job Cancels a batch job.

Parameters

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

Returns

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

create_batch(connection, batch_create_request, opts \\ [])

@spec create_batch(
  Tesla.Env.client(),
  ExBifrost.Model.BatchCreateRequest.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.BatchCreateResponse.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Create a batch job Creates a batch job for asynchronous processing.

Parameters

connection (ExBifrost.Connection): Connection to server
batch_create_request (BatchCreateRequest):
opts (keyword): Optional parameters

Returns

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

get_batch_results(connection, batch_id, provider, opts \\ [])

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

Get batch results Retrieves results from a completed batch job.

Parameters

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

Returns

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

list_batches(connection, provider, opts \\ [])

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

List batch jobs Lists batch jobs for a provider.

Parameters

connection (ExBifrost.Connection): Connection to server
provider (ModelProvider): Provider to list batches for
opts (keyword): Optional parameters
- :limit (integer()): Maximum number of batches to return
- :after (String.t): Cursor for pagination
- :before (String.t): Cursor for pagination

Returns

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

retrieve_batch(connection, batch_id, provider, opts \\ [])

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

Retrieve a batch job Retrieves a specific batch job by ID.

Parameters

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

Returns

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