LlmCall.Media.Codec behaviour (llm_call v0.1.0)

Copy Markdown View Source

The behaviour every media generation adapter implements.

A synchronous codec implements everything except decode_operation/2. An asynchronous codec also implements decode_operation/2 and declares async: true in its capabilities.

encode_submit/2 validates first, like the completion side. decode_submit/2 returns either finished assets or an LlmCall.Operation whose next request advances the job.

Summary

Callbacks

capabilities(t, t)

decode_error(wire_value, t)

@callback decode_error(LlmCall.wire_value(), LlmCall.Config.t()) :: LlmCall.Error.t()

decode_operation(wire_value, t)

(optional)
@callback decode_operation(LlmCall.wire_value(), LlmCall.Config.t()) ::
  {:ok, LlmCall.Operation.t()} | {:error, LlmCall.Error.t()}

decode_submit(wire_value, t)

@callback decode_submit(LlmCall.wire_value(), LlmCall.Config.t()) ::
  {:ok, LlmCall.Media.Response.t()} | {:error, LlmCall.Error.t()}

encode_submit(t, t)

@callback encode_submit(LlmCall.Media.Request.t(), LlmCall.Config.t()) ::
  {:ok, LlmCall.EncodedRequest.t()} | {:error, LlmCall.Error.t()}

info()

@callback info() :: LlmCall.Codec.Info.t()

validate_request(t, t)

@callback validate_request(LlmCall.Media.Request.t(), LlmCall.Config.t()) ::
  :ok | {:error, LlmCall.Error.t()}