pub struct NvExtBuilder { /* private fields */ }Expand description
Builder for NvExt.
Implementations§
Source§impl NvExtBuilder
impl NvExtBuilder
Sourcepub fn ignore_eos(&mut self, value: bool) -> &mut Self
pub fn ignore_eos(&mut self, value: bool) -> &mut Self
If true, the model will ignore the end of string token and generate to max_tokens.
pub fn top_k(&mut self, value: i32) -> &mut Self
Sourcepub fn repetition_penalty(&mut self, value: f32) -> &mut Self
pub fn repetition_penalty(&mut self, value: f32) -> &mut Self
How much to penalize tokens based on how frequently they occur in the text. A value of 1 means no penalty, while values larger than 1 discourage and values smaller encourage.
Sourcepub fn greed_sampling(&mut self, value: bool) -> &mut Self
pub fn greed_sampling(&mut self, value: bool) -> &mut Self
If true, sampling will be forced to be greedy. The backend is responsible for selecting the correct backend-specific options to implement this.
Sourcepub fn use_raw_prompt(&mut self, value: bool) -> &mut Self
pub fn use_raw_prompt(&mut self, value: bool) -> &mut Self
If true, the preproessor will try to bypass the prompt template and pass the prompt directly to to the tokenizer.
Sourcepub fn annotations(&mut self, value: Vec<String>) -> &mut Self
pub fn annotations(&mut self, value: Vec<String>) -> &mut Self
Annotations
User requests triggers which result in the request issue back out-of-band information in the SSE
stream using the event: field.
Sourcepub fn backend_instance_id(&mut self, value: i64) -> &mut Self
pub fn backend_instance_id(&mut self, value: i64) -> &mut Self
Targeted backend instance ID for the request If set, the request will be routed to backend instance with the given ID. If not set, the request will be routed to the best matching instance.
Sourcepub fn token_data(&mut self, value: Vec<u32>) -> &mut Self
pub fn token_data(&mut self, value: Vec<u32>) -> &mut Self
Pre-tokenized data to use instead of tokenizing the prompt If provided along with backend_instance_id, these tokens will be used directly and tokenization will be skipped.
Sourcepub fn guided_json(&mut self, value: Value) -> &mut Self
pub fn guided_json(&mut self, value: Value) -> &mut Self
Guided Decoding Options If specified, the output will be a JSON object. Can be a string, an object, or null.
Sourcepub fn guided_regex(&mut self, value: String) -> &mut Self
pub fn guided_regex(&mut self, value: String) -> &mut Self
If specified, the output will follow the regex pattern. Can be a string or null.
Sourcepub fn guided_grammar(&mut self, value: String) -> &mut Self
pub fn guided_grammar(&mut self, value: String) -> &mut Self
If specified, the output will follow the context-free grammar. Can be a string or null.
Sourcepub fn guided_choice(&mut self, value: Vec<String>) -> &mut Self
pub fn guided_choice(&mut self, value: Vec<String>) -> &mut Self
If specified, the output will be exactly one of the choices.
Sourcepub fn guided_decoding_backend(&mut self, value: String) -> &mut Self
pub fn guided_decoding_backend(&mut self, value: String) -> &mut Self
If specified, the backend to use for guided decoding, can be backends like xgrammar or custom guided decoding backend
Sourcepub fn max_thinking_tokens(&mut self, value: u32) -> &mut Self
pub fn max_thinking_tokens(&mut self, value: u32) -> &mut Self
Maximum number of thinking tokens allowed NOTE: Currently passed through to backends as a no-op for future implementation
Source§impl NvExtBuilder
impl NvExtBuilder
pub fn add_annotation(&mut self, annotation: impl Into<String>) -> &mut Self
Trait Implementations§
Source§impl Clone for NvExtBuilder
impl Clone for NvExtBuilder
Source§fn clone(&self) -> NvExtBuilder
fn clone(&self) -> NvExtBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for NvExtBuilder
impl RefUnwindSafe for NvExtBuilder
impl Send for NvExtBuilder
impl Sync for NvExtBuilder
impl Unpin for NvExtBuilder
impl UnwindSafe for NvExtBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::RequestSource§impl<T, U> OverflowingInto<U> for Twhere
U: OverflowingFrom<T>,
impl<T, U> OverflowingInto<U> for Twhere
U: OverflowingFrom<T>,
fn overflowing_into(self) -> (U, bool)
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);