Pixir.Provider.ResponsesRouting (pixir v0.1.12)

Copy Markdown View Source

Opaque, request-scoped routing policy for the Responses Provider.

Routing is resolved once from an already selected ResponsesBackend plus the Provider's programmatic options. The value keeps the exact validated HTTP endpoint private while exposing only redacted summaries and transport capabilities. It never selects credentials and never activates a staged backend.

A legacy injected :transport is treated as an HTTP/SSE seam. The resolved policy records both the requested and effective transports so Provider integration can pass one frozen decision to TransportPolicy without rereading application config.

Summary

Types

t()

Opaque Responses route and transport decision.

Functions

allowed_transports(responses_routing)

Ordered transport capability set advertised by the selected backend.

apply_to_opts(routing, opts)

Attach the opaque route and its effective transport to Provider options.

effective_transport(responses_routing)

Transport policy to execute for this frozen route.

http_url(responses_routing)

Validated final HTTP(S) Responses URL. Keep this request-internal.

requested_transport(responses_routing)

Transport requested before capability and injected-seam resolution.

resolve(backend, provider_opts \\ [])

Resolve one final Responses route and effective transport policy.

source(responses_routing)

Safe provenance of the final route.

summary(routing)

Redacted, JSON-friendly routing projection.

validate_binding(routing, backend)

Verify that an opaque route remains bound to the selected backend.

websocket_url(responses_routing)

Resolved ChatGPT WebSocket URL, or nil for an HTTP/SSE-only backend.

Types

t()

@opaque t()

Opaque Responses route and transport decision.

Functions

allowed_transports(responses_routing)

@spec allowed_transports(t()) :: [:websocket | :http_sse]

Ordered transport capability set advertised by the selected backend.

apply_to_opts(routing, opts)

@spec apply_to_opts(
  t(),
  keyword()
) :: keyword()

Attach the opaque route and its effective transport to Provider options.

effective_transport(responses_routing)

@spec effective_transport(t()) :: :auto | :websocket | :http_sse

Transport policy to execute for this frozen route.

http_url(responses_routing)

@spec http_url(t()) :: String.t()

Validated final HTTP(S) Responses URL. Keep this request-internal.

requested_transport(responses_routing)

@spec requested_transport(t()) :: :auto | :websocket | :http_sse

Transport requested before capability and injected-seam resolution.

resolve(backend, provider_opts \\ [])

@spec resolve(
  Pixir.Providers.ResponsesBackend.t(),
  keyword()
) :: {:ok, t()} | {:error, map()}

Resolve one final Responses route and effective transport policy.

source(responses_routing)

@spec source(t()) :: :default | :legacy_base_url | :base_url | :responses_url

Safe provenance of the final route.

summary(routing)

@spec summary(term()) :: map() | :invalid

Redacted, JSON-friendly routing projection.

validate_binding(routing, backend)

@spec validate_binding(t(), Pixir.Providers.ResponsesBackend.t()) ::
  :ok | {:error, map()}

Verify that an opaque route remains bound to the selected backend.

websocket_url(responses_routing)

@spec websocket_url(t()) :: String.t() | nil

Resolved ChatGPT WebSocket URL, or nil for an HTTP/SSE-only backend.