SoulFire LogoSoulFire

SoulFireChat

Public Python members of SoulFireChat.

Generated from the pinned SDK source. Use the matching installation. Each source link points to this baseline.

Methods decorated with @fn return effects. Their implementation signatures use EffectGen for the generator body. Compose them with yield from inside a scoped workflow.

send

@fn("SoulFireChat.send")
def send(
    self, message: str, *, idempotency_key: str | None = None, timeout_ms: int | None = None
) -> EffectGen[BotActionResult, SoulFireOperationError]

Source

command

@fn("SoulFireChat.command")
def command(
    self, command: str, *, idempotency_key: str | None = None, timeout_ms: int | None = None
) -> EffectGen[BotActionResult, SoulFireOperationError]

Source

whisper

@fn("SoulFireChat.whisper")
def whisper(
    self,
    recipient: str,
    message: str,
    *,
    idempotency_key: str | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[BotActionResult, SoulFireOperationError]

Source

complete

@fn("SoulFireChat.complete")
def complete(
    self, value: str, *, cursor: int | None = None, timeout_ms: int | None = None
) -> EffectGen[TabCompleteResponse, SoulFireOperationError]

Source

watch

def watch(
    self,
    matcher: ChatMatcher,
    *,
    sources: Iterable[ChatSource] | None = None,
    timeout_ms: int | None = None,
) -> Stream[ChatMatch, SoulFireOperationError]:
    @gen

Source

wait_for

@fn("SoulFireChat.wait_for")
def wait_for(
    self,
    matcher: ChatMatcher,
    *,
    sources: Iterable[ChatSource] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[ChatMatch, SoulFireOperationError]

Source

How is this page?

Last updated on

On this page