GitHub

API reference for config.

Per-request changes to the OpenAI client's HTTP client (Effect's OpenAiConfig)::

program.pipe(config.with_client_transform(lambda client: client.retry_transient(times=2)))

A transform set here applies after the client's own transform_client.

Values

AttributeTypeDescription
Servicetype[ClientConfig]

Types

TypeDefinitionDescription
ClientTransformtype ClientTransform = Callable[[HttpClientService[HttpClientError]], HttpClientService[HttpClientError]]

A change to a provider's HTTP client.

Classes

Functions

get_or_none

get_or_none() -> Effect[Service | None]

The provided OpenAiConfig, else None.

Returns Effect[Service | None]

def get_or_none() -> Effect[Service | None]:
    """The provided ``OpenAiConfig``, else ``None``."""
    return P.client_config(OpenAiConfig)

with_client_transform

with_client_transform(transform) -> P.WithClientTransform

Run an effect with its requests sent through transform(client). Use with .pipe.

ParameterTypeDescription
transformClientTransform

Returns P.WithClientTransform

def with_client_transform(transform: ClientTransform) -> P.WithClientTransform:
    """Run an effect with its requests sent through ``transform(client)``.
    Use with ``.pipe``."""
    return P.WithClientTransform(OpenAiConfig, transform)