Pixir.Providers.ResponsesBackend (pixir v0.1.12)

Copy Markdown View Source

Opaque policy for the Responses dialect backend selected for one request.

The value contains selection policy, not credentials. Diagnostic and Inspect projections deliberately expose only summary/1; endpoint values and future secret-bearing fields never leave the request-selection boundary.

Summary

Types

t()

Opaque Responses backend selection.

Functions

Return whether production use is active for this staged backend.

Credential policy descriptor. No credential value is stored here.

Default ChatGPT/Codex backend policy used by the legacy Responses path.

Endpoint descriptor. The endpoint value is request-internal and must not be logged.

Whether the backend came from an explicit descriptor.

Selected backend mode.

Typed optional request-extension capabilities.

Validate and normalize an explicit backend descriptor.

Total, redacted projection for diagnostic and Inspect boundaries.

Selection source.

Total, redacted, JSON-friendly diagnostic projection.

Ordered transport capabilities.

Types

t()

@opaque t()

Opaque Responses backend selection.

Functions

activation_status(backend)

@spec activation_status(t()) :: :ok | {:error, map()}

Return whether production use is active for this staged backend.

auth_policy(responses_backend)

Credential policy descriptor. No credential value is stored here.

default()

@spec default() :: t()

Default ChatGPT/Codex backend policy used by the legacy Responses path.

endpoint(responses_backend)

Endpoint descriptor. The endpoint value is request-internal and must not be logged.

explicit?(responses_backend)

Whether the backend came from an explicit descriptor.

mode(responses_backend)

Selected backend mode.

request_extensions(responses_backend)

Typed optional request-extension capabilities.

resolve(value, opts \\ [])

@spec resolve(
  term(),
  keyword()
) :: {:ok, t()} | {:error, map()}

Validate and normalize an explicit backend descriptor.

safe_summary(backend)

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

Total, redacted projection for diagnostic and Inspect boundaries.

source(responses_backend)

Selection source.

summary(backend)

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

Total, redacted, JSON-friendly diagnostic projection.

transports(responses_backend)

Ordered transport capabilities.