soulfire.client

Attributes

Classes

ManagedInstallOptions

Options for a local SoulFire server managed by the SDK.

SoulFire

A scoped client for a SoulFire server and its bot instances.

SoulFireInstance

An instance handle that groups bot accounts and configuration.

SoulFireService

Base class for protocol classes.

Functions

normalize_base_url(→ str)

connection_layer(, required_plugins, ...)

Module Contents

type soulfire.client.ClientInterceptor = UnaryInterceptor | ClientStreamInterceptor | ServerStreamInterceptor | BidiStreamInterceptor | MetadataInterceptor[Any]
soulfire.client.normalize_base_url(base_url: str) → str[source]
soulfire.client.connection_layer(base_url: str, *, token: soulfire._auth.TokenProvider | None = None, timeout_ms: int | None = None, required_capabilities: collections.abc.Iterable[str] = (), required_plugins: collections.abc.Iterable[soulfire.connection.RequiredPlugin] = ()) → effect_py.layer.Layer[SoulFireService, soulfire.errors.SoulFireOperationError][source]