Skip to main content

OpenAIChatTemplateParams

Struct OpenAIChatTemplateParams 

Source
pub struct OpenAIChatTemplateParams<'a> {
Show 14 fields pub messages_json: &'a str, pub tools_json: Option<&'a str>, pub tool_choice: Option<&'a str>, pub json_schema: Option<&'a str>, pub grammar: Option<&'a str>, pub reasoning_format: Option<&'a str>, pub chat_template_kwargs: Option<&'a str>, pub add_generation_prompt: bool, pub use_jinja: bool, pub parallel_tool_calls: bool, pub enable_thinking: bool, pub add_bos: bool, pub add_eos: bool, pub parse_tool_calls: bool,
}
Expand description

Parameters for applying OpenAI-compatible chat templates.

Fields§

§messages_json: &'a str

OpenAI-compatible messages JSON array.

§tools_json: Option<&'a str>

Optional OpenAI-compatible tools JSON array.

§tool_choice: Option<&'a str>

Optional tool choice string.

§json_schema: Option<&'a str>

Optional JSON schema string for tool grammar generation.

§grammar: Option<&'a str>

Optional custom grammar string.

§reasoning_format: Option<&'a str>

Optional reasoning format string.

§chat_template_kwargs: Option<&'a str>

Optional chat template kwargs JSON object.

§add_generation_prompt: bool

Whether to add the assistant generation prompt.

§use_jinja: bool

Whether to render templates with Jinja.

§parallel_tool_calls: bool

Whether to allow parallel tool calls.

§enable_thinking: bool

Whether thinking blocks are enabled.

§add_bos: bool

Whether to add BOS.

§add_eos: bool

Whether to add EOS.

§parse_tool_calls: bool

Whether to parse tool calls in responses.

Trait Implementations§

Source§

impl<'a> Clone for OpenAIChatTemplateParams<'a>

Source§

fn clone(&self) -> OpenAIChatTemplateParams<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for OpenAIChatTemplateParams<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> PartialEq for OpenAIChatTemplateParams<'a>

Source§

fn eq(&self, other: &OpenAIChatTemplateParams<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'a> StructuralPartialEq for OpenAIChatTemplateParams<'a>

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more