Jido.Chat.AI (Jido Chat v1.0.0)

Copy Markdown View Source

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

Summary

Types

ai_content_part()
ai_message()

Functions

to_ai_messages(messages, opts \\ [])

Alias for to_messages/2.

to_messages(messages, opts \\ [])

Converts normalized chat messages into AI-friendly role/content maps.

Types

ai_content_part()

@type ai_content_part() :: map()

ai_message()

@type ai_message() :: %{role: String.t(), content: String.t() | [ai_content_part()]}

Functions

to_ai_messages(messages, opts \\ [])

@spec to_ai_messages([Jido.Chat.Message.t() | map()], keyword() | map()) :: [
  ai_message()
]

Alias for to_messages/2.

to_messages(messages, opts \\ [])

@spec to_messages([Jido.Chat.Message.t() | map()], keyword() | map()) :: [
  ai_message()
]

Converts normalized chat messages into AI-friendly role/content maps.

Options stay Elixir-native by default, but Chat SDK-style camelCase aliases are accepted to make cross-port migration less brittle:

  • include_names or includeNames
  • transform or transformMessage
  • unsupported_attachment or onUnsupportedAttachment
  • fetch_attachment or fetchAttachment