Struct ChatApplyParams 

pub struct ChatApplyParams { /* private fields */ }

A request to render: messages, optional tools, and how to constrain output.

messages_json and tools_json are OpenAI-shaped JSON. They are passed as text rather than typed structs so this crate need not take a JSON dependency or track upstream’s message schema, which grows most releases.

Implementations

impl ChatApplyParams

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

Start from an OpenAI-shaped messages JSON array.

pub fn with_tools(self, tools_json: impl Into<String>) -> Self

Supply an OpenAI-shaped tools JSON array.

pub fn with_grammar(self, grammar: impl Into<String>) -> Self

Constrain output with a GBNF grammar directly.

pub fn with_json_schema(self, schema_json: impl Into<String>) -> Self

Constrain output with a JSON Schema. llama.cpp converts it to GBNF.

pub fn with_template_kwargs(self, kwargs_json: impl Into<String>) -> Self

Extra Jinja variables, as a JSON object.

pub fn with_tool_choice(self, choice: ToolChoice) -> Self

Set what the model may do with the tools. Defaults to ToolChoice::Auto.

pub fn with_reasoning_format(self, format: ReasoningFormat) -> Self

Set how reasoning is handled. Defaults to ReasoningFormat::Auto.

pub fn with_add_generation_prompt(self, add: bool) -> Self

Append the assistant generation prompt. Defaults to true; set false to render a transcript rather than a request.

pub fn with_enable_thinking(self, enable: bool) -> Self

Let the model think before answering, on templates that support it. Defaults to true.

pub fn with_parallel_tool_calls(self, parallel: bool) -> Self

Allow several tool calls in one turn. Defaults to false.

pub fn with_use_jinja(self, use_jinja: bool) -> Self

Render with the Jinja engine. Defaults to true; false selects the legacy llama_chat_apply_template path, which ignores tools.

pub fn with_add_bos_eos(self, add_bos: bool, add_eos: bool) -> Self

Prepend BOS / append EOS to the rendered prompt. Both default to false, since tokenization usually adds BOS itself.

Trait Implementations

impl Clone for ChatApplyParams

fn clone(&self) -> ChatApplyParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChatApplyParams

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

Formats the value using the given formatter.