Skip to main content

ChatTemplate

Struct ChatTemplate 

Source
pub struct ChatTemplate(/* private fields */);
Expand description

A compiled chat template. Cheap to clone (Arc inside) because every *Loaded struct in ferrox-server carries one and hands it to each request.

Implementations§

Source§

impl ChatTemplate

Source

pub fn from_jinja(source: &str) -> Result<Self, TemplateError>

Compiles source as Jinja2. Errors are returned, never swallowed.

Source

pub fn builtin(b: BuiltinTemplate) -> Self

Source

pub fn from_gguf_metadata( chat_template: Option<&str>, arch: Option<&str>, byte_tokenizer: bool, ) -> Self

The load-time entry point: what a GGUF’s metadata says.

  • a non-empty tokenizer.chat_template is compiled, and a compile failure is recorded (so the load still succeeds and /v1/completions still works) but makes every chat render fail with the compiler’s message;
  • no template + a real tokenizer ⇒ ChatML, matching llama.cpp --jinja’s CHATML_TEMPLATE_SRC default;
  • no template + a byte/synthetic tokenizer ⇒ Plain, since there is no real vocabulary for markers to live in.
Source

pub fn is_jinja(&self) -> bool

True when this is the checkpoint’s own compiled template.

Source

pub fn source(&self) -> Option<&str>

The compiled Jinja source, for callers that need to inspect it.

Source

pub fn handles_tools(&self) -> bool

Whether the template itself renders tools.

Templates that never mention tools cannot express a tool call, so a caller offering tools to such a checkpoint has to fall back to describing them in a system message (ferrox-server’s tool_preamble). This is a textual check on the template source, which is what llama.cpp’s common/chat.cpp does too (caps.supports_tools is probed by rendering, but the cheap source check is what gates it here).

Source

pub fn describe(&self) -> String

Short human-readable identity, for the load-time log line.

Source

pub fn render( &self, messages: &[Value], opts: &RenderOptions, ) -> Result<String, TemplateError>

Renders messages (OpenAI-shaped JSON objects) into a prompt.

Trait Implementations§

Source§

impl Clone for ChatTemplate

Source§

fn clone(&self) -> ChatTemplate

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ChatTemplate

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.