Backplane.AgentRuntime.Provider behaviour (backplane_agent_runtime v1.6.0)

Copy Markdown

ProviderPort boundary for Backplane agent runtime.

Summary

Types

adapter()

Callbacks

chunks(list)
start(map)

Functions

complete_stream(adapter, chunks)
start(adapter, request, context)

Types

adapter()

@type adapter() :: module()

Callbacks

chunks(list)

@callback chunks([map()]) :: {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

start(map)

@callback start(map()) :: {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

Functions

complete_stream(adapter, chunks)

@spec complete_stream(adapter(), [map()]) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

start(adapter, request, context)

@spec start(adapter(), map(), map()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}