Struct ChatBuilder 

pub struct ChatBuilder { /* private fields */ }

Builder for creating and sending chat requests to the LLM canister.

Implementations

impl ChatBuilder

pub fn new(model: impl Into<String>) -> Self

Creates a new chat builder with a model.

model is the canister’s model identifier, e.g. "llama3.1:8b" (free) or "gemma3:27b" (paid). See the README for the current list.

pub fn with_messages(self, messages: Vec<ChatMessage>) -> Self

Sets the messages for the chat.

pub fn with_tools(self, tools: Vec<Tool>) -> Self

Sets the tools for the chat.

pub fn with_canister(self, canister: Principal) -> Self

Overrides the LLM canister to call.

By default the SDK addresses the mainnet LLM canister (w36hm-eqaaa-aaaal-qr76a-cai), unless icp deploy has auto-injected PUBLIC_CANISTER_ID:llm on this canister — in which case that value is used. Set this only when neither default is what you want (e.g. when pointing at a fork, a mock, or a staging deployment under a different name).

pub async fn send(self) -> Response

Sends the chat request to the LLM canister.

Attaches CYCLES_PER_CHAT cycles to pay for paid models. Free models refund the full amount. The calling canister must hold at least that many cycles or this call traps.

Trait Implementations

impl Debug for ChatBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.