ExAthena.Provider behaviour (ExAthena v0.4.7)

Copy Markdown View Source

Behaviour every provider must implement.

A provider is a thin adapter between ExAthena.Request and a remote (or local) inference endpoint. It is expected to:

  1. Normalise the request into the provider's native wire format.
  2. Perform the HTTP call (or SDK call, for Claude).
  3. Parse the response (or stream) back into an ExAthena.Response / ExAthena.Streaming.Event sequence.
  4. Surface errors as {:error, %ExAthena.Error{}} tuples using the canonical kinds.

Capabilities

Each provider declares its capabilities statically. The loop uses these to decide the tool-call protocol and fallback strategy. See ExAthena.Capabilities for the shape.

Summary

Callbacks

capabilities()

Static capability map for this provider.

query(t, opts)

Perform a one-shot request and return the final response.

stream(t, function, opts)

Stream a request; callback is invoked with each Streaming.Event. Must still return {:ok, final_response} when the stream completes normally.

Callbacks

capabilities()

@callback capabilities() :: ExAthena.Capabilities.t()

Static capability map for this provider.

query(t, opts)

@callback query(ExAthena.Request.t(), opts :: keyword()) ::
  {:ok, ExAthena.Response.t()} | {:error, term()}

Perform a one-shot request and return the final response.

stream(t, function, opts)

(optional) 
@callback stream(
  ExAthena.Request.t(),
  (ExAthena.Streaming.Event.t() -> term()),
  opts :: keyword()
) ::
  {:ok, ExAthena.Response.t()} | {:error, term()}

Stream a request; callback is invoked with each Streaming.Event. Must still return {:ok, final_response} when the stream completes normally.