pub struct OpenAIPreprocessor { /* private fields */ }
Implementations§
Source§impl OpenAIPreprocessor
impl OpenAIPreprocessor
pub fn new(mdc: ModelDeploymentCard) -> Result<Arc<Self>>
pub fn new_with_parts( mdc: ModelDeploymentCard, formatter: Arc<dyn OAIPromptFormatter>, hf_tokenizer: Tokenizer, ) -> Result<Arc<Self>>
Sourcepub fn preprocess_request<R: OAIChatLikeRequest + AnnotationsProvider + SamplingOptionsProvider + StopConditionsProvider + OutputOptionsProvider + NvExtProvider>(
&self,
request: &R,
) -> Result<(PreprocessedRequest, HashMap<String, String>)>
pub fn preprocess_request<R: OAIChatLikeRequest + AnnotationsProvider + SamplingOptionsProvider + StopConditionsProvider + OutputOptionsProvider + NvExtProvider>( &self, request: &R, ) -> Result<(PreprocessedRequest, HashMap<String, String>)>
Translate a NvCreateChatCompletionRequest
request to a common completion request.
Returns both the common completion request and a hashmap of annotations.
Annotations evaluated by this method include:
formatted_prompt
token_ids
pub fn builder<R: OAIChatLikeRequest + AnnotationsProvider + SamplingOptionsProvider + StopConditionsProvider + OutputOptionsProvider + NvExtProvider>( &self, request: &R, ) -> Result<PreprocessedRequestBuilder>
pub fn apply_template<R: OAIChatLikeRequest + AnnotationsProvider + SamplingOptionsProvider + StopConditionsProvider + OutputOptionsProvider + NvExtProvider>( &self, request: &R, ) -> Result<Option<String>>
pub fn gather_tokens<R: OAIChatLikeRequest + AnnotationsProvider + SamplingOptionsProvider + StopConditionsProvider + OutputOptionsProvider + NvExtProvider>( &self, request: &R, builder: &mut PreprocessedRequestBuilder, formatted_prompt: Option<String>, ) -> Result<HashMap<String, String>>
Sourcepub async fn preprocess_embedding_request(
&self,
request: &NvCreateEmbeddingRequest,
) -> Result<(PreprocessedEmbeddingRequest, HashMap<String, String>)>
pub async fn preprocess_embedding_request( &self, request: &NvCreateEmbeddingRequest, ) -> Result<(PreprocessedEmbeddingRequest, HashMap<String, String>)>
Preprocess an embedding request, handling both text and token ID inputs.
For text inputs, tokenizes the text using the configured tokenizer. For token ID inputs, uses the provided token IDs directly and skips tokenization.
Returns both the preprocessed request and a hashmap of annotations.
pub fn transform_postprocessor_stream<S, Resp>( stream: S, generator: Box<dyn DeltaGeneratorExt<Resp>>, context: Arc<dyn AsyncEngineContext>, ) -> impl Stream<Item = Annotated<Resp>> + Send
Sourcepub fn transform_embedding_postprocessor_stream<S>(
stream: S,
original_request: NvCreateEmbeddingRequest,
) -> impl Stream<Item = Annotated<NvCreateEmbeddingResponse>> + Send
pub fn transform_embedding_postprocessor_stream<S>( stream: S, original_request: NvCreateEmbeddingRequest, ) -> impl Stream<Item = Annotated<NvCreateEmbeddingResponse>> + Send
Transform engine embedding output stream to OpenAI embedding response stream
Sourcepub fn should_apply_tool_jail(
tool_call_parser: Option<&String>,
tool_choice: Option<&ChatCompletionToolChoiceOption>,
has_tools: bool,
) -> Result<bool, Error>
pub fn should_apply_tool_jail( tool_call_parser: Option<&String>, tool_choice: Option<&ChatCompletionToolChoiceOption>, has_tools: bool, ) -> Result<bool, Error>
Determine if we should apply the tool calling jail based on configuration Returns Ok(true) if jail should be applied, Ok(false) if not, or Err if invalid config
Sourcepub fn apply_tool_calling_jail<S>(
tool_call_parser: String,
stream: S,
) -> impl Stream<Item = Annotated<NvCreateChatCompletionStreamResponse>> + Send
pub fn apply_tool_calling_jail<S>( tool_call_parser: String, stream: S, ) -> impl Stream<Item = Annotated<NvCreateChatCompletionStreamResponse>> + Send
Apply tool calling jail to the stream if needed
Trait Implementations§
Source§impl Operator<Context<NvCreateChatCompletionRequest>, Pin<Box<dyn AsyncEngineStream<Annotated<CreateChatCompletionStreamResponse>, Item = Annotated<CreateChatCompletionStreamResponse>>>>, Context<PreprocessedRequest>, Pin<Box<dyn AsyncEngineStream<Annotated<BackendOutput>, Item = Annotated<BackendOutput>>>>> for OpenAIPreprocessor
impl Operator<Context<NvCreateChatCompletionRequest>, Pin<Box<dyn AsyncEngineStream<Annotated<CreateChatCompletionStreamResponse>, Item = Annotated<CreateChatCompletionStreamResponse>>>>, Context<PreprocessedRequest>, Pin<Box<dyn AsyncEngineStream<Annotated<BackendOutput>, Item = Annotated<BackendOutput>>>>> for OpenAIPreprocessor
Source§fn generate<'life0, 'async_trait>(
&'life0 self,
request: SingleIn<NvCreateChatCompletionRequest>,
next: Arc<dyn AsyncEngine<SingleIn<PreprocessedRequest>, ManyOut<Annotated<BackendOutput>>, Error>>,
) -> Pin<Box<dyn Future<Output = Result<ManyOut<Annotated<NvCreateChatCompletionStreamResponse>>, Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn generate<'life0, 'async_trait>(
&'life0 self,
request: SingleIn<NvCreateChatCompletionRequest>,
next: Arc<dyn AsyncEngine<SingleIn<PreprocessedRequest>, ManyOut<Annotated<BackendOutput>>, Error>>,
) -> Pin<Box<dyn Future<Output = Result<ManyOut<Annotated<NvCreateChatCompletionStreamResponse>>, Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
UpIn
to the downstream request DownIn
,
call the next AsyncEngine
with the transformed request, then transform the downstream response
DownOut
to the upstream response UpOut
.fn into_operator(
self: &Arc<Self>,
) -> Arc<PipelineOperator<UpIn, UpOut, DownIn, DownOut>>where
Self: Sized,
Source§impl Operator<Context<NvCreateCompletionRequest>, Pin<Box<dyn AsyncEngineStream<Annotated<NvCreateCompletionResponse>, Item = Annotated<NvCreateCompletionResponse>>>>, Context<PreprocessedRequest>, Pin<Box<dyn AsyncEngineStream<Annotated<BackendOutput>, Item = Annotated<BackendOutput>>>>> for OpenAIPreprocessor
impl Operator<Context<NvCreateCompletionRequest>, Pin<Box<dyn AsyncEngineStream<Annotated<NvCreateCompletionResponse>, Item = Annotated<NvCreateCompletionResponse>>>>, Context<PreprocessedRequest>, Pin<Box<dyn AsyncEngineStream<Annotated<BackendOutput>, Item = Annotated<BackendOutput>>>>> for OpenAIPreprocessor
Source§fn generate<'life0, 'async_trait>(
&'life0 self,
request: SingleIn<NvCreateCompletionRequest>,
next: Arc<dyn AsyncEngine<SingleIn<PreprocessedRequest>, ManyOut<Annotated<BackendOutput>>, Error>>,
) -> Pin<Box<dyn Future<Output = Result<ManyOut<Annotated<NvCreateCompletionResponse>>, Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn generate<'life0, 'async_trait>(
&'life0 self,
request: SingleIn<NvCreateCompletionRequest>,
next: Arc<dyn AsyncEngine<SingleIn<PreprocessedRequest>, ManyOut<Annotated<BackendOutput>>, Error>>,
) -> Pin<Box<dyn Future<Output = Result<ManyOut<Annotated<NvCreateCompletionResponse>>, Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
UpIn
to the downstream request DownIn
,
call the next AsyncEngine
with the transformed request, then transform the downstream response
DownOut
to the upstream response UpOut
.fn into_operator(
self: &Arc<Self>,
) -> Arc<PipelineOperator<UpIn, UpOut, DownIn, DownOut>>where
Self: Sized,
Source§impl Operator<Context<NvCreateEmbeddingRequest>, Pin<Box<dyn AsyncEngineStream<Annotated<NvCreateEmbeddingResponse>, Item = Annotated<NvCreateEmbeddingResponse>>>>, Context<PreprocessedEmbeddingRequest>, Pin<Box<dyn AsyncEngineStream<Annotated<EmbeddingsEngineOutput>, Item = Annotated<EmbeddingsEngineOutput>>>>> for OpenAIPreprocessor
impl Operator<Context<NvCreateEmbeddingRequest>, Pin<Box<dyn AsyncEngineStream<Annotated<NvCreateEmbeddingResponse>, Item = Annotated<NvCreateEmbeddingResponse>>>>, Context<PreprocessedEmbeddingRequest>, Pin<Box<dyn AsyncEngineStream<Annotated<EmbeddingsEngineOutput>, Item = Annotated<EmbeddingsEngineOutput>>>>> for OpenAIPreprocessor
Source§fn generate<'life0, 'async_trait>(
&'life0 self,
request: SingleIn<NvCreateEmbeddingRequest>,
next: Arc<dyn AsyncEngine<SingleIn<PreprocessedEmbeddingRequest>, ManyOut<Annotated<EmbeddingsEngineOutput>>, Error>>,
) -> Pin<Box<dyn Future<Output = Result<ManyOut<Annotated<NvCreateEmbeddingResponse>>, Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn generate<'life0, 'async_trait>(
&'life0 self,
request: SingleIn<NvCreateEmbeddingRequest>,
next: Arc<dyn AsyncEngine<SingleIn<PreprocessedEmbeddingRequest>, ManyOut<Annotated<EmbeddingsEngineOutput>>, Error>>,
) -> Pin<Box<dyn Future<Output = Result<ManyOut<Annotated<NvCreateEmbeddingResponse>>, Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
UpIn
to the downstream request DownIn
,
call the next AsyncEngine
with the transformed request, then transform the downstream response
DownOut
to the upstream response UpOut
.fn into_operator(
self: &Arc<Self>,
) -> Arc<PipelineOperator<UpIn, UpOut, DownIn, DownOut>>where
Self: Sized,
Auto Trait Implementations§
impl Freeze for OpenAIPreprocessor
impl !RefUnwindSafe for OpenAIPreprocessor
impl Send for OpenAIPreprocessor
impl Sync for OpenAIPreprocessor
impl Unpin for OpenAIPreprocessor
impl !UnwindSafe for OpenAIPreprocessor
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> 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::Request
Source§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);