API Reference Jido Chat v#1.2.0

Copy Markdown View Source

Modules

Core adapter-contract facade and lightweight event-loop state container.

Framework-agnostic conversion helpers for turning chat history into AI-ready messages.

Normalized action/button event payload placeholder for Phase 2.

Canonical adapter behavior for Chat SDK style integrations.

Reusable ExUnit support for independent Jido.Chat.Adapter packages.

Shared ExUnit assertions for adapter contract tests.

Deterministic factories for adapter contract tests.

A deterministic adapter for contract and adapter-extension tests.

A small deterministic state process for adapter tests.

A deterministic provider-free transport for adapter tests.

Behaviour for channel-specific mention detection and parsing.

Behaviour for adapter-specific threading support.

Normalized assistant-context-changed event.

Normalized assistant-thread-started event.

Normalized outbound attachment used by post payloads and sent-message handles.

Canonical author identity used by normalized incoming messages.

Capabilities negotiation for adapters and participants.

Adapter capability declaration matrix (:native | :fallback | :unsupported).

Canonical cross-platform card model with fallback rendering helpers.

One provider-neutral data point in a canonical card chart.

One named series whose ordered values align with chart categories.

Canonical card component used by Jido.Chat.Card.

Canonical channel metadata payload.

Normalized channel-level metadata for Jido.Chat.Incoming.

Channel handle for adapter-routed posting, state, and metadata access.

Chat-level overlapping-message concurrency configuration.

Audio content block for messages.

File attachment content block for messages.

Image content block for messages.

Text content block for messages.

Tool result content block for messages.

Tool use content block for messages.

Video content block for messages.

Cross-platform emoji helper with a small default registry and custom overrides.

Canonical result of an ephemeral send attempt.

Splode error aggregator for Jido.Chat.

Inbound routing error wrapper for request/event transport flows.

Schema validation error for named Jido.Chat structs.

Canonical normalized event envelope used by webhook and gateway ingestion.

Canonical options for paginated history fetch operations.

Canonical outbound file upload request used by posting and upload helpers.

Lightweight ID generator for SDK structs.

Canonical normalized inbound message/event payload.

Transport-agnostic typed inbound routing result.

Canonical Markdown AST and formatting helpers.

Canonical Markdown AST node used by Jido.Chat.Markdown.

Builds safe Markdown snapshots from an incremental, provider-independent stream.

Normalized media entry used in Jido.Chat.Incoming.

Resolves media types without applying a provider-independent default.

Normalized mention entry used in Jido.Chat.Incoming.

Chat SDK-style normalized message model.

Ordered message context for a collapsed queue or burst dispatch.

A normalized event for deletion of an existing message.

Canonical page of normalized messages for thread/channel history.

Normalized subject for a resource-backed conversation.

A normalized event for content or metadata changes to an existing message.

Canonical outbound message target.

Canonical modal open payload and builder helpers.

Canonical modal element used by Jido.Chat.Modal.

Normalized modal close event payload placeholder for Phase 2.

Canonical modal lifecycle response used by submit and close handlers.

Typed normalized modal-open result.

Normalized modal submit event payload placeholder for Phase 2.

Typed error or timeout from a dynamic select option loader.

Normalized request to load options for an external or dynamic select.

Provider-neutral option returned by a dynamic select loader.

A labeled group of provider-neutral dynamic select options.

Successful, typed output from a dynamic select option loader.

Represents a participant in conversations (human, agent, or system).

Typed normalized outbound payload used by thread/channel posting helpers.

Typed post payload accepted by thread/channel post helpers.

Normalized reaction event payload placeholder for Phase 2.

Shallow quoted-message context preserved with a message reply.

Canonical normalized outbound send/edit result.

Represents a conversation room/chat.

Canonical sent-message handle with follow-up lifecycle operations.

Normalized slash-command event payload placeholder for Phase 2.

Behavior and helpers for pluggable chat state storage.

Default in-memory state adapter.

Typed stream input chunk used by outbound stream payloads.

Thread handle with posting, lifecycle, state, and discovery helpers.

Canonical page of thread summaries.

Lightweight thread descriptor for channel-level thread listing.

Normalized provider user information.

Typed webhook request envelope used for adapter verification and parsing.

Typed webhook response envelope.