preprocessor.rs 67.1 KB
Newer Older
1
// SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
Biswa Panda's avatar
Biswa Panda committed
2
3
4
5
6
// SPDX-License-Identifier: Apache-2.0

//! The Preprocessor consists of the following modules
//!
//! - `translation`: This module converts the allowed Ingress message types to the corresponding
7
//!   internal representation.
Biswa Panda's avatar
Biswa Panda committed
8
9
10
11
12
13
//! - `apply`: This module applies ModelConfig defaults to any empty optional fields specified
//! - `prompt`: This module applies any prompt template logic to the internal Request object.
//! - `tokenize`: This module tokenizes the formatted prompt string and returns the token ids.
//!
//! The Preprocessor will accept any IngressRequest and transform it to a BackendRequest.

14
pub mod media;
Biswa Panda's avatar
Biswa Panda committed
15
pub mod prompt;
Yan Ru Pei's avatar
Yan Ru Pei committed
16
pub mod speculative_prefill;
Biswa Panda's avatar
Biswa Panda committed
17
pub mod tools;
18
use anyhow::Context;
19
use anyhow::{Result, bail};
20

21
22
23
24
use dynamo_async_openai::types::{
    ChatCompletionRequestMessage, ChatCompletionRequestUserMessageContent,
    ChatCompletionRequestUserMessageContentPart, ChatCompletionToolChoiceOption, EncodingFormat,
};
25
use dynamo_runtime::error::{DynamoError, ErrorType};
Ryan Olson's avatar
Ryan Olson committed
26
use futures::Stream;
Biswa Panda's avatar
Biswa Panda committed
27
28
use futures::stream::{self, StreamExt};
use prompt::OAIPromptFormatter;
29
use std::time::{Duration, Instant};
Ryan Olson's avatar
Ryan Olson committed
30
use std::{collections::HashMap, pin::Pin, sync::Arc};
Biswa Panda's avatar
Biswa Panda committed
31
32
use tracing;

33
use crate::model_card::{ModelDeploymentCard, ModelInfo};
34
use crate::preprocessor::media::MediaLoader;
Biswa Panda's avatar
Biswa Panda committed
35
use crate::preprocessor::prompt::OAIChatLikeRequest;
36
use crate::protocols::common::preprocessor::{
37
    MultimodalData, MultimodalDataMap, PreprocessedRequestBuilder, RoutingHints,
38
};
39
use crate::protocols::common::timing::RequestTracker;
40
use crate::tokenizers::Encoding;
Biswa Panda's avatar
Biswa Panda committed
41

42
use dynamo_parsers::{ReasoningParser, ReasoningParserType};
Neelay Shah's avatar
Neelay Shah committed
43
44
use dynamo_runtime::engine::{AsyncEngine, AsyncEngineContextProvider, ResponseStream};
use dynamo_runtime::pipeline::{
45
    AsyncEngineContext, Error, ManyOut, Operator, SingleIn, async_trait,
Biswa Panda's avatar
Biswa Panda committed
46
};
Neelay Shah's avatar
Neelay Shah committed
47
use dynamo_runtime::protocols::annotated::{Annotated, AnnotationsProvider};
Biswa Panda's avatar
Biswa Panda committed
48
49

use crate::protocols::{
Greg Clark's avatar
Greg Clark committed
50
    common::{OutputOptionsProvider, SamplingOptionsProvider, StopConditionsProvider},
Biswa Panda's avatar
Biswa Panda committed
51
    openai::{
52
        DeltaGeneratorExt,
Ryan Olson's avatar
Ryan Olson committed
53
54
55
        chat_completions::{
            NvCreateChatCompletionRequest, NvCreateChatCompletionStreamResponse, jail::JailedStream,
        },
56
        completions::{NvCreateCompletionRequest, NvCreateCompletionResponse},
57
        embeddings::{NvCreateEmbeddingRequest, NvCreateEmbeddingResponse},
Biswa Panda's avatar
Biswa Panda committed
58
59
60
        nvext::NvExtProvider,
    },
};
Nikita's avatar
Nikita committed
61
use crate::tokenizers::traits::Tokenizer;
Biswa Panda's avatar
Biswa Panda committed
62

63
use crate::preprocessor::prompt::{PromptFormatter, PromptInput, TextInput, TokenInput};
Biswa Panda's avatar
Biswa Panda committed
64

65
pub use crate::protocols::common::llm_backend::{BackendOutput, PreprocessedRequest};
66
67
68
pub use crate::protocols::common::preprocessor::PreprocessedEmbeddingRequest;

use crate::protocols::common::llm_backend::EmbeddingsEngineOutput;
Biswa Panda's avatar
Biswa Panda committed
69
70
71

pub const ANNOTATION_FORMATTED_PROMPT: &str = "formatted_prompt";
pub const ANNOTATION_TOKEN_IDS: &str = "token_ids";
72
73
74
75
76
77
pub const ANNOTATION_LLM_METRICS: &str = "llm_metrics";
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct LLMMetricAnnotation {
    pub input_tokens: usize,
    pub output_tokens: usize,
    pub chunk_tokens: usize,
78
    pub cached_tokens: Option<usize>,
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
    /// Prefill worker ID (for TTFT attribution in disaggregated mode)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub prefill_worker_id: Option<u64>,
    /// Prefill worker DP rank
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub prefill_dp_rank: Option<u32>,
    /// Prefill worker type ("prefill" or "decode") for Prometheus metric labeling.
    /// Stored at routing time to avoid expensive MDC lookup when updating TTFT metrics.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub prefill_worker_type: Option<String>,
    /// Decode worker ID (for ITL attribution in disaggregated mode)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub decode_worker_id: Option<u64>,
    /// Decode worker DP rank
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub decode_dp_rank: Option<u32>,
    /// Decode worker type ("prefill" or "decode") for Prometheus metric labeling.
    /// Stored at routing time to avoid expensive MDC lookup when updating ITL metrics.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub decode_worker_type: Option<String>,
99
    #[serde(default, skip_serializing_if = "Option::is_none")]
100
101
102
103
104
    pub tokenize_latency: Option<Duration>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub detokenize_total_latency: Option<Duration>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub detokenize_count: Option<u64>,
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
}

impl LLMMetricAnnotation {
    /// Convert this metrics struct to an Annotated event
    pub fn to_annotation<T>(&self) -> Result<Annotated<T>, serde_json::Error> {
        Annotated::from_annotation(ANNOTATION_LLM_METRICS, self)
    }

    /// Extract LLM metrics from an Annotated event, if present
    pub fn from_annotation<T>(
        annotation: &Annotated<T>,
    ) -> Result<Option<LLMMetricAnnotation>, Box<dyn std::error::Error>> {
        if annotation.event.is_none() {
            return Ok(None);
        }
        if annotation.event.as_ref().unwrap() != ANNOTATION_LLM_METRICS {
            return Ok(None);
        }
        let comments = annotation
            .comment
            .as_ref()
            .ok_or("missing comments block")?;
        if comments.len() != 1 {
            return Err("malformed comments block - expected exactly 1 comment".into());
        }
        let metrics: LLMMetricAnnotation = serde_json::from_str(&comments[0])?;
        Ok(Some(metrics))
    }
}
Biswa Panda's avatar
Biswa Panda committed
134

135
136
137
138
139
140
// Reasoning State for reasoning parsing transformation step
struct ReasoningState {
    stream: Pin<Box<dyn Stream<Item = Annotated<NvCreateChatCompletionStreamResponse>> + Send>>,
    reasoning_parser: Option<Box<dyn ReasoningParser>>,
}

Biswa Panda's avatar
Biswa Panda committed
141
142
143
144
145
pub struct OpenAIPreprocessor {
    mdcsum: String,
    formatter: Arc<dyn OAIPromptFormatter>,
    tokenizer: Arc<dyn Tokenizer>,
    model_info: Arc<dyn ModelInfo>,
146
    lora_name: Option<String>,
147
148
    /// Per-model runtime configuration propagated to response generator (e.g., reasoning/tool parser)
    runtime_config: crate::local_model::runtime_config::ModelRuntimeConfig,
149
    tool_call_parser: Option<String>,
150
    media_loader: Option<MediaLoader>,
151
152
    /// Max context length (in tokens) this model can handle, from ModelDeploymentCard
    context_length: u32,
Biswa Panda's avatar
Biswa Panda committed
153
154
155
}

impl OpenAIPreprocessor {
156
157
    pub fn new(mdc: ModelDeploymentCard) -> Result<Arc<Self>> {
        let formatter = PromptFormatter::from_mdc(&mdc)?;
Nikita's avatar
Nikita committed
158
        let tokenizer = mdc.tokenizer()?;
159
        match formatter {
160
            PromptFormatter::OAI(formatter) => Self::new_with_parts(mdc, formatter, tokenizer),
161
162
163
        }
    }

164
    pub fn new_with_parts(
165
166
        mdc: ModelDeploymentCard,
        formatter: Arc<dyn OAIPromptFormatter>,
Nikita's avatar
Nikita committed
167
        tokenizer: crate::tokenizers::Tokenizer,
168
    ) -> Result<Arc<Self>> {
169
        let mdcsum = mdc.mdcsum().to_string();
Nikita's avatar
Nikita committed
170
        let tokenizer: Arc<dyn Tokenizer> = (*tokenizer).clone();
171
        let lora_name = mdc.lora.as_ref().map(|l| l.name.clone());
172
        let Some(ref model_info) = mdc.model_info else {
173
174
175
176
            anyhow::bail!(
                "Blank ModelDeploymentCard cannot be used for pre-processing, no model_info"
            );
        };
177
        let model_info = model_info.get_model_info()?;
178
        let tool_call_parser = mdc.runtime_config.tool_call_parser.clone();
Biswa Panda's avatar
Biswa Panda committed
179

180
181
182
183
        if let Some(ref lora_name) = lora_name {
            tracing::info!(model = %mdc.display_name, lora_name, "LoRA adapter detected in MDC");
        }

184
185
        // // Initialize runtime config from the ModelDeploymentCard
        let runtime_config = mdc.runtime_config.clone();
186
187
188
189
190
191

        let media_loader = match mdc.media_decoder {
            Some(media_decoder) => Some(MediaLoader::new(media_decoder, mdc.media_fetcher)?),
            None => None,
        };

192
193
        let context_length = mdc.context_length;

Biswa Panda's avatar
Biswa Panda committed
194
195
196
197
198
        Ok(Arc::new(Self {
            formatter,
            tokenizer,
            model_info,
            mdcsum,
199
            lora_name,
200
            runtime_config,
201
            tool_call_parser,
202
            media_loader,
203
            context_length,
Biswa Panda's avatar
Biswa Panda committed
204
205
        }))
    }
206
207
208
209
210
    /// Encode a string to it's tokens
    pub fn tokenize(&self, s: &str) -> anyhow::Result<Encoding> {
        self.tokenizer.encode(s)
    }

211
    /// Translate a [`NvCreateChatCompletionRequest`] request to a common completion request.
212
213
214
    /// Returns the common completion request, a hashmap of annotations, and a boolean
    /// indicating whether the rendered prompt ends with a reasoning start token (e.g.,
    /// `<think>`), meaning the model's completion will begin mid-reasoning.
Biswa Panda's avatar
Biswa Panda committed
215
216
217
218
    ///
    /// Annotations evaluated by this method include:
    /// - `formatted_prompt`
    /// - `token_ids`
219
    pub async fn preprocess_request<
Biswa Panda's avatar
Biswa Panda committed
220
221
222
223
        R: OAIChatLikeRequest
            + AnnotationsProvider
            + SamplingOptionsProvider
            + StopConditionsProvider
Greg Clark's avatar
Greg Clark committed
224
            + OutputOptionsProvider
Biswa Panda's avatar
Biswa Panda committed
225
226
227
228
            + NvExtProvider,
    >(
        &self,
        request: &R,
229
        tracker: Option<&RequestTracker>,
230
    ) -> Result<(PreprocessedRequest, HashMap<String, String>, bool)> {
231
        let mut builder = self.builder(request)?;
232
233
234
        let formatted_prompt = self
            .apply_template(request)
            .with_context(|| "Failed to apply prompt template")?;
235
236
237
238
239
240
241
242
243

        // Check if the chat template injected a reasoning start token at the end
        // of the prompt (e.g., Qwen3.5 appends `<think>\n` when enable_thinking
        // is not explicitly false). If so, the model's completion starts
        // mid-reasoning and the parser should begin in reasoning mode.
        let prompt_injected_reasoning = formatted_prompt
            .as_ref()
            .is_some_and(|p| p.trim_end().ends_with("<think>"));

244
        let annotations = self
245
            .gather_tokens(request, &mut builder, formatted_prompt.clone(), tracker)
246
            .with_context(|| "Failed to gather tokens")?;
247
        self.gather_multi_modal_data(request, &mut builder, formatted_prompt)
248
            .await
249
            .with_context(|| "Failed to gather multimodal data")?;
250

251
        Ok((builder.build()?, annotations, prompt_injected_reasoning))
252
253
254
255
256
257
258
259
260
261
262
263
264
    }

    pub fn builder<
        R: OAIChatLikeRequest
            + AnnotationsProvider
            + SamplingOptionsProvider
            + StopConditionsProvider
            + OutputOptionsProvider
            + NvExtProvider,
    >(
        &self,
        request: &R,
    ) -> Result<PreprocessedRequestBuilder> {
265
        let mut builder = PreprocessedRequest::builder();
266
        builder.model(request.model());
Biswa Panda's avatar
Biswa Panda committed
267

268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
        let mut stop_conditions = request.extract_stop_conditions()?;
        if let Some(stop_tokens) = &mut stop_conditions.stop_token_ids_hidden {
            for eos_token in self.model_info.eos_token_ids() {
                if !stop_tokens.contains(&eos_token) {
                    stop_tokens.push(eos_token);
                }
            }
        } else {
            stop_conditions.stop_token_ids_hidden = Some(self.model_info.eos_token_ids());
        }

        // apply ignore eos if not already set
        stop_conditions.apply_ignore_eos();

        if !stop_conditions.ignore_eos.unwrap_or(false) {
            builder.eos_token_ids(self.model_info.eos_token_ids());
        }

        builder.stop_conditions(stop_conditions);
        builder.sampling_options(request.extract_sampling_options()?);
        builder.output_options(request.extract_output_options()?);
        builder.annotations(request.annotations().unwrap_or_default());
        builder.mdc_sum(Some(self.mdcsum.clone()));
291
292
        let lora_name = self.lora_name.clone();

293
294
295
        // Extract cache_control TTL from either nvext or top-level field
        let cache_control_ttl = request.effective_cache_control().map(|cc| cc.ttl_seconds());

296
        // Extract routing hints from nvext if present
297
        if let Some(nvext) = request.nvext() {
298
            // Build routing hints from nvext fields
299
            let hints = nvext.agent_hints.as_ref();
300
            builder.request_timestamp_ms(nvext.request_timestamp_ms);
301
302
303
304
305
            let routing = RoutingHints {
                backend_instance_id: nvext.backend_instance_id,
                prefill_worker_id: nvext.prefill_worker_id,
                decode_worker_id: nvext.decode_worker_id,
                dp_rank: None, // dp_rank is set later in the pipeline
306
                expected_output_tokens: hints.and_then(|h| h.osl),
307
308
309
310
311
                priority_jump: hints.and_then(|h| {
                    h.priority
                        .map(|priority| priority.max(0) as f64)
                        .or(h.latency_sensitivity)
                }),
312
                priority: hints.and_then(|h| h.priority),
313
                lora_name,
314
                cache_control_ttl: nvext.cache_control.as_ref().map(|cc| cc.ttl_seconds()),
315
                allowed_worker_ids: None,
316
317
            };
            builder.routing(Some(routing));
318
319
320
        } else if lora_name.is_some() || cache_control_ttl.is_some() {
            // Ensure routing hints exist when we have LoRA or cache_control,
            // even when nvext is absent (e.g. Anthropic endpoint requests).
321
322
            builder.routing(Some(RoutingHints {
                lora_name,
323
                cache_control_ttl,
324
325
                ..Default::default()
            }));
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
        }

        Ok(builder)
    }

    pub fn apply_template<
        R: OAIChatLikeRequest
            + AnnotationsProvider
            + SamplingOptionsProvider
            + StopConditionsProvider
            + OutputOptionsProvider
            + NvExtProvider,
    >(
        &self,
        request: &R,
    ) -> Result<Option<String>> {
        if let PromptInput::Text(_) = request.prompt_input_type()
            && let Some(TextInput::Single(_)) = request.extract_text()
        {
            let use_raw_prompt = request
                .nvext()
                .is_some_and(|ext| ext.use_raw_prompt.unwrap_or(false));

            let formatted_prompt = if use_raw_prompt {
                match request.raw_prompt() {
                    Some(prompt) => prompt,
                    None => {
                        tracing::warn!("Raw prompt requested but not available");
                        self.formatter.render(request)?
                    }
                }
            } else {
                self.formatter.render(request)?
            };
            Ok(Some(formatted_prompt))
        } else {
            Ok(None)
        }
    }

366
    pub async fn gather_multi_modal_data<R: OAIChatLikeRequest>(
367
368
369
        &self,
        request: &R,
        builder: &mut PreprocessedRequestBuilder,
370
        formatted_prompt: Option<String>,
371
372
    ) -> Result<()> {
        let mut media_map: MultimodalDataMap = HashMap::new();
373
374
        let mut fetch_tasks: Vec<(String, ChatCompletionRequestUserMessageContentPart)> =
            Vec::new();
375

376
377
378
379
380
        let Some(messages) = request.typed_messages() else {
            return Ok(());
        };
        for message in messages.iter() {
            let content_parts = match message {
381
382
383
384
385
386
387
                ChatCompletionRequestMessage::User(u) => match &u.content {
                    ChatCompletionRequestUserMessageContent::Array(parts) => parts,
                    _ => continue,
                },
                _ => continue,
            };
            // Iterate over content parts
388
            for content_part in content_parts.iter() {
389
390
391
392
393
394
395
396
397
398
399
400
401
                let (type_str, url) = match content_part {
                    ChatCompletionRequestUserMessageContentPart::ImageUrl(image_part) => {
                        ("image_url".to_string(), image_part.image_url.url.clone())
                    }
                    ChatCompletionRequestUserMessageContentPart::VideoUrl(video_part) => {
                        ("video_url".to_string(), video_part.video_url.url.clone())
                    }
                    ChatCompletionRequestUserMessageContentPart::AudioUrl(audio_part) => {
                        ("audio_url".to_string(), audio_part.audio_url.url.clone())
                    }
                    _ => continue,
                };

402
403
                if self.media_loader.is_some() {
                    fetch_tasks.push((type_str, content_part.clone()));
404
                    continue;
405
                }
406
407
408
409
410
411

                //Fallback: ust pass the URL through
                media_map
                    .entry(type_str)
                    .or_default()
                    .push(MultimodalData::Url(url));
412
413
            }
        }
414
415
416
417

        // Execute all fetch tasks
        if !fetch_tasks.is_empty() {
            let loader = self.media_loader.as_ref().unwrap();
418
419
420
421
            let media_io_kwargs = request.media_io_kwargs();
            let results = futures::future::join_all(fetch_tasks.iter().map(|(_, content_part)| {
                loader.fetch_and_decode_media_part(content_part, media_io_kwargs)
            }))
422
423
            .await;

424
425
426
427
428
429
430
431
            for ((type_str, _), result) in fetch_tasks.into_iter().zip(results.into_iter()) {
                // if one item fails, errors the whole request, other items will be cleaned up by Drop
                let rdma_descriptor = result?;
                media_map
                    .entry(type_str)
                    .or_default()
                    .push(MultimodalData::Decoded(rdma_descriptor));
            }
432
433
        }

434
435
        if !media_map.is_empty() {
            builder.multi_modal_data(Some(media_map));
436

437
438
439
            // Preserve original messages and formatted prompt in extra_args for multimodal
            // workers (e.g., TRT-LLM needs messages and the template-rendered prompt with
            // <image> placeholders for embedding-path / NIXL flows).
440
            let messages_json = serde_json::to_value(request.messages())?;
441
            let mut extra_args = serde_json::json!({
442
443
                "messages": messages_json
            });
444
445
446
            if let Some(ref prompt) = formatted_prompt {
                extra_args["formatted_prompt"] = serde_json::Value::String(prompt.clone());
            }
447
            builder.extra_args(Some(extra_args));
448
449
450
451
452
        }

        Ok(())
    }

453
454
455
456
457
458
459
460
461
462
463
464
    pub fn gather_tokens<
        R: OAIChatLikeRequest
            + AnnotationsProvider
            + SamplingOptionsProvider
            + StopConditionsProvider
            + OutputOptionsProvider
            + NvExtProvider,
    >(
        &self,
        request: &R,
        builder: &mut PreprocessedRequestBuilder,
        formatted_prompt: Option<String>,
465
        tracker: Option<&RequestTracker>,
466
467
    ) -> Result<HashMap<String, String>> {
        let mut annotations = HashMap::new();
468
        let mut token_count: Option<usize> = None;
469
470
471
472
473
474
        // match request type before any conversion/processing
        match request.prompt_input_type() {
            PromptInput::Tokens(_) => {
                if let Some(token_input) = request.extract_tokens() {
                    match token_input {
                        TokenInput::Single(tokens) => {
475
                            token_count = Some(tokens.len());
476
477
478
479
                            builder.token_ids(tokens);
                        }
                        TokenInput::Batch(token_batches) => {
                            if token_batches.len() == 1 {
480
                                token_count = Some(token_batches[0].len());
481
482
                                builder.token_ids(token_batches[0].clone());
                            } else {
483
484
485
486
                                bail!(
                                    "Batch token input not supported for more than one token in requests (got {})",
                                    token_batches.len()
                                );
487
488
489
                            }
                        }
                    }
Biswa Panda's avatar
Biswa Panda committed
490
491
                }
            }
492
493
494
            PromptInput::Text(_) => {
                if let Some(text_input) = request.extract_text() {
                    match text_input {
495
496
497
498
499
500
501
502
503
504
                        TextInput::Single(raw_prompt) => {
                            if let Some(f) = formatted_prompt.as_ref()
                                && request.has_annotation(ANNOTATION_FORMATTED_PROMPT)
                            {
                                annotations
                                    .insert(ANNOTATION_FORMATTED_PROMPT.to_string(), f.to_string());
                            }

                            // Completions will use raw_prompt, no template
                            let prompt = formatted_prompt.unwrap_or(raw_prompt);
Biswa Panda's avatar
Biswa Panda committed
505

506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
                            // Check if backend_instance_id is present and token_data is provided
                            let has_backend_instance_id = request
                                .nvext()
                                .and_then(|ext| ext.backend_instance_id)
                                .is_some();

                            let token_data =
                                request.nvext().and_then(|ext| ext.token_data.as_ref());

                            let (tokens_vec, skip_token_annotation) = if has_backend_instance_id {
                                if let Some(tokens) = token_data {
                                    tracing::trace!(
                                        "Using provided tokens from EPP: {} ids",
                                        tokens.len()
                                    );
                                    // need ownership for the builder, so clone.
                                    (tokens.clone(), true)
                                } else {
                                    tracing::warn!(
                                        "backend_instance_id provided but no token_data; tokenizing prompt"
                                    );
527
                                    let encoding = self.encode_with_timing(&prompt, tracker)?;
528
529
530
531
                                    (encoding.token_ids().to_vec(), false)
                                }
                            } else {
                                // No backend_instance_id provided, continue the normal flow.
532
                                let encoding = self.encode_with_timing(&prompt, tracker)?;
533
534
                                (encoding.token_ids().to_vec(), false)
                            };
Biswa Panda's avatar
Biswa Panda committed
535

536
537
538
                            if request.has_annotation(ANNOTATION_TOKEN_IDS)
                                && !skip_token_annotation
                            {
539
540
                                annotations.insert(
                                    ANNOTATION_TOKEN_IDS.to_string(),
541
                                    serde_json::to_string(&tokens_vec)?,
542
543
544
                                );
                            }

545
                            token_count = Some(tokens_vec.len());
546
                            builder.token_ids(tokens_vec);
547
548
                        }
                        TextInput::Batch(texts) => {
549
                            if texts.len() == 1 {
550
                                let encoding = self.encode_with_timing(&texts[0], tracker)?;
551
552
553
                                let tokens = encoding.token_ids().to_vec();
                                token_count = Some(tokens.len());
                                builder.token_ids(tokens);
554
555
556
557
558
559
                            } else {
                                bail!(
                                    "Batch text input not supported for more than one text in requests (got {})",
                                    texts.len()
                                );
                            }
560
561
562
563
                        }
                    }
                }
            }
Biswa Panda's avatar
Biswa Panda committed
564
        }
565
566
567
568
569
570

        // Validate prompt token count against model's context length
        if let Some(count) = token_count {
            Self::validate_token_count(count, self.context_length)?;
        }

571
        Ok(annotations)
Biswa Panda's avatar
Biswa Panda committed
572
573
    }

574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
    /// Validate that the prompt token count does not consume the model's entire context length.
    /// Returns an error if the prompt leaves no room for output tokens.
    fn validate_token_count(token_count: usize, context_length: u32) -> Result<()> {
        let max_len = context_length as usize;
        // max_len == 0 means context_length was not configured (model_card.rs defaults
        // to 0 when max_position_embeddings is absent), so skip validation.
        // Use >= because context_length is the total budget (input + output): if the
        // prompt alone fills it, there is zero room for output tokens.
        if max_len > 0 && token_count >= max_len {
            return Err(DynamoError::builder()
                .error_type(ErrorType::InvalidArgument)
                .message(format!(
                    "This model's maximum context length is {} tokens. \
                     However, your messages resulted in {} tokens. \
                     Please reduce the length of the messages.",
                    max_len, token_count,
                ))
                .build()
                .into());
        }
        Ok(())
    }

597
598
599
600
601
602
603
604
    fn encode_with_timing(
        &self,
        prompt: &str,
        tracker: Option<&RequestTracker>,
    ) -> anyhow::Result<Encoding> {
        let encode_start = Instant::now();
        let encoding = self.tokenizer.encode(prompt)?;
        if let Some(t) = tracker {
605
            t.record_tokenize_latency(encode_start.elapsed());
606
607
608
609
        }
        Ok(encoding)
    }

610
611
612
613
614
615
616
617
618
619
620
621
622
623
    /// 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 async fn preprocess_embedding_request(
        &self,
        request: &NvCreateEmbeddingRequest,
    ) -> Result<(PreprocessedEmbeddingRequest, HashMap<String, String>)> {
        let mut annotations = HashMap::new();
        let mut builder = PreprocessedEmbeddingRequest::builder();

        let all_token_ids = match &request.inner.input {
624
            dynamo_async_openai::types::EmbeddingInput::String(s) => {
625
626
                let encoding = self.tokenizer.encode(s)?;
                vec![encoding.token_ids().to_vec()]
627
            }
628
            dynamo_async_openai::types::EmbeddingInput::StringArray(arr) => {
629
630
631
632
633
634
635
636
637
638
639
                let input_strs: Vec<String> = arr.to_vec();
                let encodings = tokio::task::spawn_blocking({
                    let tokenizer = self.tokenizer.clone();
                    let strs = input_strs.clone();
                    move || {
                        tokenizer.encode_batch(&strs.iter().map(|s| s.as_str()).collect::<Vec<_>>())
                    }
                })
                .await??;
                let token_arrays: Vec<Vec<u32>> = encodings
                    .into_iter()
640
                    .map(|encoding| encoding.token_ids().to_vec())
641
642
643
                    .collect();
                token_arrays
            }
644
645
646
647
            dynamo_async_openai::types::EmbeddingInput::IntegerArray(token_ids) => {
                vec![token_ids.clone()]
            }
            dynamo_async_openai::types::EmbeddingInput::ArrayOfIntegerArray(token_arrays) => {
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
                token_arrays.clone()
            }
        };

        // Handle annotations
        if request.has_annotation(ANNOTATION_TOKEN_IDS) {
            annotations.insert(
                ANNOTATION_TOKEN_IDS.to_string(),
                serde_json::to_string(&all_token_ids)?,
            );
        }

        builder.token_ids(all_token_ids);
        builder.model(request.inner.model.clone());
        builder.encoding_format(request.inner.encoding_format.as_ref().map(|f| match f {
            EncodingFormat::Float => "float".to_string(),
            EncodingFormat::Base64 => "base64".to_string(),
        }));
        builder.dimensions(request.inner.dimensions);

        builder.annotations(request.annotations().unwrap_or_default());
        builder.mdc_sum(Some(self.mdcsum.clone()));

        Ok((builder.build()?, annotations))
    }

674
675
676
677
    pub fn postprocessor_parsing_stream<S>(
        &self,
        stream: S,
        request: &NvCreateChatCompletionRequest,
678
        prompt_injected_reasoning: bool,
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
    ) -> anyhow::Result<
        impl Stream<Item = Annotated<NvCreateChatCompletionStreamResponse>> + Send + 'static,
    >
    where
        S: Stream<Item = Annotated<NvCreateChatCompletionStreamResponse>> + Send + 'static,
    {
        // Try to parse reasoning content only if parser is configured
        let should_parse_reasoning = self.runtime_config.reasoning_parser.is_some()
            && !Self::is_reasoning_disabled_by_request(
                self.runtime_config.reasoning_parser.as_deref(),
                request.chat_template_args.as_ref(),
            );

        // Reasoning Content Parsing Transformation Step
        // Current Solution:
        // This step operates on Deltas created by the transform_postprocessor_stream function
        // Only access to text and not token_ids - so can not support parsing based on token_ids for now
        // Future Solution:
        // To address the limitation if needed in future: move this step before transform_postprocessor_stream and add new field of reasoning_content to the backend output
        // Use backend_output.reasoning_content field to fill out the deltas.
        let stream: Pin<Box<dyn Stream<Item = _> + Send>> = if should_parse_reasoning {
            Box::pin(Self::parse_reasoning_content_from_stream(
                stream,
                self.runtime_config.reasoning_parser.clone().unwrap(), // Safety: We already checked that parser is some, so gtg
703
                prompt_injected_reasoning,
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
            ))
        } else {
            Box::pin(stream)
        };

        // Check if tools are present and if we should apply jail
        let has_tools = request
            .inner
            .tools
            .as_ref()
            .is_some_and(|tools| !tools.is_empty());

        // Determine if we should apply jail (do this before moving request)
        let should_jail = Self::should_apply_tool_jail(
            self.tool_call_parser.as_ref(),
            request.inner.tool_choice.as_ref(),
            has_tools,
        )?;

        // Convert OpenAI tools to parser ToolDefinition format before applying jail
        let tool_definitions = request.inner.tools.as_ref().map(|tools| {
            tools
                .iter()
                .map(|tool| dynamo_parsers::tool_calling::ToolDefinition {
                    name: tool.function.name.clone(),
                    parameters: tool.function.parameters.clone(),
                })
                .collect()
        });

        // Apply jail conditionally
        let transformed_stream: Pin<Box<dyn Stream<Item = _> + Send>> = if should_jail {
            Box::pin(Self::apply_tool_calling_jail(
                self.tool_call_parser.clone(),
                request.inner.tool_choice.clone(),
                tool_definitions,
                stream,
            ))
        } else {
            Box::pin(stream)
        };

        Ok(transformed_stream)
    }

Ryan Olson's avatar
Ryan Olson committed
749
750
    pub fn transform_postprocessor_stream<S, Resp>(
        stream: S,
Biswa Panda's avatar
Biswa Panda committed
751
        generator: Box<dyn DeltaGeneratorExt<Resp>>,
Ryan Olson's avatar
Ryan Olson committed
752
753
754
755
756
757
758
759
760
761
762
        context: Arc<dyn AsyncEngineContext>,
    ) -> impl Stream<Item = Annotated<Resp>> + Send
    where
        S: Stream<Item = Annotated<BackendOutput>> + Send + 'static,
        Resp: Send + Sync + 'static + std::fmt::Debug,
    {
        struct State<Resp>
        where
            Resp: Send + Sync + 'static + std::fmt::Debug,
        {
            response_stream: Pin<Box<dyn Stream<Item = Annotated<BackendOutput>> + Send>>,
Biswa Panda's avatar
Biswa Panda committed
763
764
765
            response_generator: Box<dyn DeltaGeneratorExt<Resp>>,
            context: Arc<dyn AsyncEngineContext>,
            cancelled: bool,
766
            cumulative_output_tokens: usize,
767
768
            finish_reason_sent: bool,
            usage_chunk_sent: bool,
Ryan Olson's avatar
Ryan Olson committed
769
            finished: bool,
Biswa Panda's avatar
Biswa Panda committed
770
771
772
        }

        let state = State {
Ryan Olson's avatar
Ryan Olson committed
773
            response_stream: Box::pin(stream),
Biswa Panda's avatar
Biswa Panda committed
774
775
776
            response_generator: generator,
            context: context.clone(),
            cancelled: false,
777
            cumulative_output_tokens: 0,
778
779
            finish_reason_sent: false,
            usage_chunk_sent: false,
Ryan Olson's avatar
Ryan Olson committed
780
            finished: false,
Biswa Panda's avatar
Biswa Panda committed
781
782
783
        };

        // transform the common response stream into a chat response stream
Ryan Olson's avatar
Ryan Olson committed
784
785

        stream::unfold(state, |mut inner| {
Biswa Panda's avatar
Biswa Panda committed
786
            async move {
787
788
789
790
791
                // If already finished, return None immediately
                if inner.finished {
                    return None;
                }

Biswa Panda's avatar
Biswa Panda committed
792
793
794
795
796
797
                if let Some(response) = inner.response_stream.next().await {
                    if inner.cancelled {
                        tracing::debug!(
                            request_id = inner.context.id(),
                            "Cancellation issued last message; closing stream"
                        );
798
                        // inner.finished = true; // Mark as finished
Biswa Panda's avatar
Biswa Panda committed
799
800
801
802
803
804
805
806
807
                        return None;
                    }

                    tracing::trace!(
                        request_id = inner.context.id(),
                        "Processing common response: {:?}",
                        response
                    );

808
809
810
811
812
813
814
                    // Check if this response has a finish_reason
                    let has_finish_reason = response
                        .data
                        .as_ref()
                        .map(|d| d.finish_reason.is_some())
                        .unwrap_or(false);

815
816
817
818
819
820
821
822
823
824
825
826
827
828
                    let (chunk_tokens, isl) = if let Some(ref backend_output) = response.data {
                        let chunk_tokens = backend_output.token_ids.len();
                        inner.cumulative_output_tokens += chunk_tokens;

                        let isl = inner.response_generator.get_isl().unwrap_or(0) as usize;

                        (chunk_tokens, isl)
                    } else {
                        (0, 0)
                    };

                    let current_osl = inner.cumulative_output_tokens;

                    let mut response = response.map_data(|data| {
Biswa Panda's avatar
Biswa Panda committed
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
                        inner
                            .response_generator
                            .choice_from_postprocessor(data)
                            .inspect_err(|e| {
                                tracing::error!(
                                    request_id = inner.context.id(),
                                    "Error processing common response: {:?}",
                                    e
                                );
                                inner.cancelled = true;
                                inner.context.stop_generating();
                            })
                            .map_err(|e| e.to_string())
                    });

844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
                    // Create LLM metrics annotation with prefill/decode worker info from tracker.
                    // Worker types are stored at routing time to avoid expensive MDC lookup.
                    let tracker = inner.response_generator.tracker();
                    let prefill_worker_id = tracker.as_ref().and_then(|t| t.prefill_worker_id());
                    let prefill_dp_rank = tracker.as_ref().and_then(|t| t.prefill_dp_rank());
                    let prefill_worker_type = tracker
                        .as_ref()
                        .and_then(|t| t.prefill_worker_type())
                        .map(String::from);
                    let decode_worker_id = tracker.as_ref().and_then(|t| t.decode_worker_id());
                    let decode_dp_rank = tracker.as_ref().and_then(|t| t.decode_dp_rank());
                    let decode_worker_type = tracker
                        .as_ref()
                        .and_then(|t| t.decode_worker_type())
                        .map(String::from);
859
860
861
862
                    let llm_metrics = LLMMetricAnnotation {
                        input_tokens: isl,
                        output_tokens: current_osl,
                        chunk_tokens,
863
                        cached_tokens: None,
864
865
866
867
868
869
                        prefill_worker_id,
                        prefill_dp_rank,
                        prefill_worker_type,
                        decode_worker_id,
                        decode_dp_rank,
                        decode_worker_type,
870
871
872
                        tokenize_latency: tracker.as_ref().and_then(|t| t.tokenize_latency()),
                        detokenize_total_latency: tracker.as_ref().and_then(|t| t.detokenize_total_latency()),
                        detokenize_count: tracker.as_ref().map(|t| t.detokenize_count()),
873
874
875
876
877
878
                    };

                    if let Ok(metrics_annotated) = llm_metrics.to_annotation::<()>() {
                        // Only set event if not already set to avoid overriding existing events (like errors)
                        if response.event.is_none() {
                            response.event = metrics_annotated.event;
879
                            response.comment = metrics_annotated.comment;
880
881
                        }
                    }
882

883
884
885
886
887
                    // Mark if we've seen a finish_reason
                    if has_finish_reason {
                        inner.finish_reason_sent = true;
                    }

Biswa Panda's avatar
Biswa Panda committed
888
889
                    tracing::trace!(
                        request_id = inner.context.id(),
890
                        "OpenAI NvCreateChatCompletionStreamResponse: {:?}",
Biswa Panda's avatar
Biswa Panda committed
891
892
893
894
895
                        response
                    );

                    Some((response, inner))
                } else {
896
897
898
899
                    // Stream has ended - must set finished to true to prevent unfold from polling
                    // again. The stream is exhausted and will panic if polled after None.
                    inner.finished = true;

900
                    if inner.finish_reason_sent && !inner.usage_chunk_sent {
901
902
903
                        inner.usage_chunk_sent = true;

                        let usage_chunk = inner.response_generator.create_usage_chunk();
904
                        let usage = inner.response_generator.get_usage();
905
906
907
908
909
910
911
912
913
914
915
916
917
918
                        let tracker = inner.response_generator.tracker();
                        let prefill_worker_id =
                            tracker.as_ref().and_then(|t| t.prefill_worker_id());
                        let prefill_dp_rank = tracker.as_ref().and_then(|t| t.prefill_dp_rank());
                        let prefill_worker_type = tracker
                            .as_ref()
                            .and_then(|t| t.prefill_worker_type())
                            .map(String::from);
                        let decode_worker_id = tracker.as_ref().and_then(|t| t.decode_worker_id());
                        let decode_dp_rank = tracker.as_ref().and_then(|t| t.decode_dp_rank());
                        let decode_worker_type = tracker
                            .as_ref()
                            .and_then(|t| t.decode_worker_type())
                            .map(String::from);
919
920
921
922
923
924
925
926
                        let llm_metrics = LLMMetricAnnotation {
                            input_tokens: usage.prompt_tokens as usize,
                            output_tokens: usage.completion_tokens as usize,
                            chunk_tokens: 0,
                            cached_tokens: usage
                                .prompt_tokens_details
                                .as_ref()
                                .and_then(|d| d.cached_tokens.map(|c| c as usize)),
927
928
929
930
931
932
                            prefill_worker_id,
                            prefill_dp_rank,
                            prefill_worker_type,
                            decode_worker_id,
                            decode_dp_rank,
                            decode_worker_type,
933
934
935
936
937
                            tokenize_latency: tracker.as_ref().and_then(|t| t.tokenize_latency()),
                            detokenize_total_latency: tracker
                                .as_ref()
                                .and_then(|t| t.detokenize_total_latency()),
                            detokenize_count: tracker.as_ref().map(|t| t.detokenize_count()),
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
                        };

                        // Create annotation string
                        let annotation = llm_metrics.to_annotation::<()>().unwrap_or_else(|e| {
                            tracing::warn!("Failed to serialize metrics: {}", e);
                            Annotated::<()>::from_data(())
                        });

                        // Send the usage chunk if needed
                        let data = if inner.response_generator.is_usage_enabled() {
                            Some(usage_chunk)
                        } else {
                            None
                        };

953
954
                        let annotated_usage = Annotated::<Resp> {
                            id: None,
955
956
957
                            data,
                            event: Some(ANNOTATION_LLM_METRICS.to_string()),
                            comment: annotation.comment,
958
                            error: None,
959
960
961
962
                        };

                        tracing::trace!(
                            request_id = inner.context.id(),
963
964
                            "Sending final usage chunk for OpenAI compliance, annotated_usage: {:?}",
                            annotated_usage
965
966
967
968
969
970
971
                        );

                        Some((annotated_usage, inner))
                    } else {
                        // stream closed
                        None
                    }
Biswa Panda's avatar
Biswa Panda committed
972
973
                }
            }
Ryan Olson's avatar
Ryan Olson committed
974
        })
975
        .fuse()
Biswa Panda's avatar
Biswa Panda committed
976
    }
977
978

    /// Transform engine embedding output stream to OpenAI embedding response stream
Ryan Olson's avatar
Ryan Olson committed
979
980
    pub fn transform_embedding_postprocessor_stream<S>(
        stream: S,
981
        original_request: NvCreateEmbeddingRequest,
Ryan Olson's avatar
Ryan Olson committed
982
983
984
985
986
    ) -> impl Stream<Item = Annotated<NvCreateEmbeddingResponse>> + Send
    where
        S: Stream<Item = Annotated<EmbeddingsEngineOutput>> + Send + 'static,
    {
        stream.map(move |output| {
987
988
            output.map_data(|engine_output| {
                // Convert engine output to OpenAI response format
989
                let embeddings: Vec<dynamo_async_openai::types::Embedding> = engine_output
990
991
992
                    .embeddings
                    .into_iter()
                    .enumerate()
993
                    .map(|(index, embedding)| dynamo_async_openai::types::Embedding {
994
995
996
997
998
999
1000
                        index: index as u32,
                        object: "embedding".to_string(),
                        embedding: embedding.into_iter().map(|f| f as f32).collect(),
                    })
                    .collect();

                let response = NvCreateEmbeddingResponse {
1001
                    inner: dynamo_async_openai::types::CreateEmbeddingResponse {
1002
1003
1004
                        object: "list".to_string(),
                        model: original_request.inner.model.clone(),
                        data: embeddings,
1005
                        usage: dynamo_async_openai::types::EmbeddingUsage {
1006
1007
1008
1009
1010
1011
1012
1013
                            prompt_tokens: engine_output.prompt_tokens,
                            total_tokens: engine_output.total_tokens,
                        },
                    },
                };

                Ok(response)
            })
Ryan Olson's avatar
Ryan Olson committed
1014
        })
1015
1016
    }

Ryan Olson's avatar
Ryan Olson committed
1017
1018
1019
1020
1021
1022
1023
1024
    /// 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
    pub fn should_apply_tool_jail(
        tool_call_parser: Option<&String>,
        tool_choice: Option<&ChatCompletionToolChoiceOption>,
        has_tools: bool,
    ) -> std::result::Result<bool, Error> {
        match (tool_call_parser, tool_choice, has_tools) {
1025
1026
1027
1028
1029
            // tool_choice=required/named work without parser (use Immediate jail mode)
            (None, Some(ChatCompletionToolChoiceOption::Required), true) => Ok(true),
            (None, Some(ChatCompletionToolChoiceOption::Named(_)), true) => Ok(true),

            // tool_choice=auto requires a parser
Ryan Olson's avatar
Ryan Olson committed
1030
1031
1032
1033
1034
1035
            (None, Some(ChatCompletionToolChoiceOption::Auto), true) => {
                tracing::warn!(
                    "Tool choice 'auto' specified but no tool parser configured; proceeding without jailing"
                );
                Ok(false)
            }
1036

Ryan Olson's avatar
Ryan Olson committed
1037
1038
1039
            // Parser exists and tools might be called
            (Some(_), Some(ChatCompletionToolChoiceOption::None), _) => {
                Ok(false) // Explicitly disabled
1040
            }
Ryan Olson's avatar
Ryan Olson committed
1041
1042
            (Some(_), Some(_), true) => Ok(true), // Any other tool_choice with tools
            (Some(_), None, true) => Ok(true),    // Default behavior when tools present
1043

Ryan Olson's avatar
Ryan Olson committed
1044
1045
1046
1047
            // No tools or no parser
            _ => Ok(false),
        }
    }
1048

Ryan Olson's avatar
Ryan Olson committed
1049
1050
    /// Apply tool calling jail to the stream if needed
    pub fn apply_tool_calling_jail<S>(
1051
1052
        tool_call_parser: Option<String>,
        tool_choice: Option<dynamo_async_openai::types::ChatCompletionToolChoiceOption>,
1053
        tool_definitions: Option<Vec<dynamo_parsers::tool_calling::ToolDefinition>>,
Ryan Olson's avatar
Ryan Olson committed
1054
1055
1056
1057
1058
        stream: S,
    ) -> impl Stream<Item = Annotated<NvCreateChatCompletionStreamResponse>> + Send
    where
        S: Stream<Item = Annotated<NvCreateChatCompletionStreamResponse>> + Send + 'static,
    {
1059
1060
1061
1062
        use dynamo_async_openai::types::ChatCompletionToolChoiceOption;

        let mut builder = JailedStream::builder();

1063
1064
1065
1066
1067
1068
1069
        // Set tool definitions if provided
        if let Some(tool_definitions) = tool_definitions
            && !tool_definitions.is_empty()
        {
            builder = builder.tool_definitions(tool_definitions);
        }

1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
        // Configure jail based on tool_choice
        match tool_choice {
            Some(ChatCompletionToolChoiceOption::Named(named)) => {
                // Immediate jail mode for named tool choice
                builder = builder.tool_choice_named(named.function.name.clone());
            }
            Some(ChatCompletionToolChoiceOption::Required) => {
                // Immediate jail mode for required tool choice
                builder = builder.tool_choice_required();
            }
            Some(ChatCompletionToolChoiceOption::Auto)
            | Some(ChatCompletionToolChoiceOption::None)
            | None => {
                // Traditional marker-based jail for auto/none/unspecified
                if let Some(parser) = tool_call_parser {
                    builder = builder.tool_call_parser(parser);
                }
            }
        }

        let jail = builder.build();
1091
        jail.apply_with_finish_reason(stream)
Ryan Olson's avatar
Ryan Olson committed
1092
    }
1093

1094
1095
    /// Check if reasoning parsing should be disabled based on per-request parameters.
    /// For kimi_k25: disabled when chat_template_args contains "thinking": false.
1096
1097
    /// For nemotron_nano: disabled when chat_template_args contains "enable_thinking": false
    ///   or "force_nonempty_content": true.
1098
1099
    /// For deepseek_r1: disabled when chat_template_args contains "thinking": false
    ///   or "thinking_mode": "chat".
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
    fn is_reasoning_disabled_by_request(
        reasoning_parser: Option<&str>,
        chat_template_args: Option<&std::collections::HashMap<String, serde_json::Value>>,
    ) -> bool {
        match reasoning_parser {
            Some("kimi_k25") => {
                if let Some(args) = chat_template_args
                    && let Some(thinking) = args.get("thinking")
                {
                    return thinking == &serde_json::Value::Bool(false);
                }
                false
            }
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
            Some("nemotron_nano") | Some("nemotron3") => {
                if let Some(args) = chat_template_args {
                    if let Some(enable_thinking) = args.get("enable_thinking")
                        && enable_thinking == &serde_json::Value::Bool(false)
                    {
                        return true;
                    }
                    if let Some(force_nonempty) = args.get("force_nonempty_content")
                        && force_nonempty == &serde_json::Value::Bool(true)
                    {
                        return true;
                    }
1125
1126
1127
                }
                false
            }
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
            Some("deepseek_r1") => {
                if let Some(args) = chat_template_args {
                    if let Some(thinking) = args.get("thinking") {
                        return thinking == &serde_json::Value::Bool(false);
                    }
                    if let Some(mode) = args.get("thinking_mode").and_then(|v| v.as_str()) {
                        return mode == "chat";
                    }
                }
                false
            }
1139
1140
1141
1142
            _ => false,
        }
    }

1143
1144
1145
    // Motivation: Each transformation on the stream should be a separate step to allow for more flexibility
    // Earlier reasoning parser logic was nested under delta generation logic in choice_from_postprocessor
    // Since we have tool calling parsing as separate step, it makes sense to have reasoning parser as separate step as well
1146
1147
1148
1149
1150
1151
1152
    /// Apply reasoning parsing to the output stream, splitting content into
    /// `reasoning_content` and normal `content` based on think tags.
    ///
    /// When `prompt_injected_reasoning` is `true`, the parser starts in reasoning
    /// mode immediately — use this when the chat template already appended the
    /// reasoning start token (e.g., `<think>`) to the prompt, so the model's
    /// completion begins with thinking content without an explicit start tag.
1153
1154
1155
    pub fn parse_reasoning_content_from_stream<S>(
        stream: S,
        parser_name: String,
1156
        prompt_injected_reasoning: bool,
1157
1158
1159
1160
1161
    ) -> impl Stream<Item = Annotated<NvCreateChatCompletionStreamResponse>> + Send
    where
        S: Stream<Item = Annotated<NvCreateChatCompletionStreamResponse>> + Send + 'static,
    {
        // Initialize reasoning parser from parser_name
1162
        let mut reasoning_parser = Box::new(ReasoningParserType::get_reasoning_parser_from_name(
1163
1164
1165
            parser_name.as_ref(),
        )) as Box<dyn ReasoningParser>;

1166
1167
1168
1169
        if prompt_injected_reasoning {
            reasoning_parser.set_in_reasoning(true);
        }

1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
        let state = ReasoningState {
            stream: Box::pin(stream),
            reasoning_parser: Some(reasoning_parser),
        };

        stream::unfold(state, |mut state| async move {
            if let Some(response) = state.stream.next().await {
                // Process the response through reasoning parser if available
                let processed_response = if let Some(ref mut parser) = state.reasoning_parser {
                    response.map_data(|mut data| {
                        // Process all choices, not just the first one
                        for choice in data.choices.iter_mut() {
1182
1183
1184
1185
1186
1187
1188
                            // Reasoning parsing only applies to text content
                            if let Some(
                                dynamo_async_openai::types::ChatCompletionMessageContent::Text(
                                    text,
                                ),
                            ) = choice.delta.content.as_ref()
                            {
1189
1190
1191
1192
                                let parser_result =
                                    parser.parse_reasoning_streaming_incremental(text, &[]);

                                // Update this specific choice with parsed content
1193
1194
1195
                                choice.delta.content = parser_result.get_some_normal_text().map(
                                    dynamo_async_openai::types::ChatCompletionMessageContent::Text,
                                );
1196
1197
                                choice.delta.reasoning_content = parser_result.get_some_reasoning();
                            }
1198
                            // For multimodal content, pass through unchanged
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
                        }
                        Ok(data)
                    })
                } else {
                    // No reasoning parser configured, pass through unchanged
                    response
                };

                Some((processed_response, state))
            } else {
                None
            }
        })
1212
        .fuse()
1213
    }
Biswa Panda's avatar
Biswa Panda committed
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
}

// for pals, we do not want to add the generation prompt to the formatted prompt
// we also need to know if the template support this add_generation_prompt bool
// any prompt template that does not support this should return an error
// oob - we should update any prompt template that does not support this to support it

#[async_trait]
impl
    Operator<
1224
        SingleIn<NvCreateChatCompletionRequest>,
1225
        ManyOut<Annotated<NvCreateChatCompletionStreamResponse>>,
1226
        SingleIn<PreprocessedRequest>,
Biswa Panda's avatar
Biswa Panda committed
1227
1228
1229
1230
1231
        ManyOut<Annotated<BackendOutput>>,
    > for OpenAIPreprocessor
{
    async fn generate(
        &self,
1232
        request: SingleIn<NvCreateChatCompletionRequest>,
Biswa Panda's avatar
Biswa Panda committed
1233
        next: Arc<
1234
            dyn AsyncEngine<SingleIn<PreprocessedRequest>, ManyOut<Annotated<BackendOutput>>, Error>,
Biswa Panda's avatar
Biswa Panda committed
1235
        >,
1236
    ) -> Result<ManyOut<Annotated<NvCreateChatCompletionStreamResponse>>, Error> {
Biswa Panda's avatar
Biswa Panda committed
1237
        // unpack the request
1238
1239
1240
1241
        let (mut request, context) = request.into_parts();

        // Preserve original inbound streaming flag before any internal overrides
        let request_id = context.id().to_string();
1242
        let original_stream_flag = request.inner.stream.unwrap_or(false);
1243

1244
        // Build audit handle (None if no DYN_AUDIT_SINKS)
1245
1246
1247
1248
1249
1250
        let mut audit_handle = crate::audit::handle::create_handle(&request, &request_id);

        if let Some(ref mut h) = audit_handle {
            h.set_request(std::sync::Arc::new(request.clone()));
        }

1251
1252
1253
1254
1255
        // For non-streaming requests (stream=false), enable usage by default
        // This ensures compliance with OpenAI API spec where non-streaming responses
        // always include usage statistics
        request.enable_usage_for_nonstreaming(original_stream_flag);

1256
1257
        // Set stream=true for internal processing (after audit capture)
        request.inner.stream = Some(true);
Biswa Panda's avatar
Biswa Panda committed
1258
1259

        // create a response generator
1260
        let response_generator = request.response_generator(context.id().to_string());
1261
        let tracker = response_generator.tracker();
Ryan Olson's avatar
Ryan Olson committed
1262
1263

        // convert the chat completion request to a common completion request
1264
        let (mut common_request, annotations, prompt_injected_reasoning) = self
1265
1266
            .preprocess_request(&request, tracker.as_deref())
            .await?;
1267
        tracing::trace!(request = ?common_request, prompt_injected_reasoning, "Pre-processed request");
1268
1269

        // Attach the timing tracker to the request so downstream components can record metrics
1270
        common_request.tracker = tracker;
Ryan Olson's avatar
Ryan Olson committed
1271

Biswa Panda's avatar
Biswa Panda committed
1272
1273
        let mut response_generator = Box::new(response_generator);

1274
1275
1276
1277
1278
        // Update ISL only for text prompts (embeddings get sequence length from tensor shape)
        if common_request.prompt_embeds.is_none() {
            let isl = common_request.token_ids.len() as u32;
            response_generator.update_isl(isl);
        }
Biswa Panda's avatar
Biswa Panda committed
1279
1280
1281
1282
1283

        // repack the common completion request
        let common_request = context.map(|_| common_request);

        // create a stream of annotations this will be prepend to the response stream
1284
        let annotations: Vec<Annotated<NvCreateChatCompletionStreamResponse>> = annotations
Biswa Panda's avatar
Biswa Panda committed
1285
1286
1287
1288
1289
1290
1291
            .into_iter()
            .flat_map(|(k, v)| Annotated::from_annotation(k, &v))
            .collect();
        let annotations_stream = stream::iter(annotations);

        // forward the common completion request to the next operator
        let response_stream = next.generate(common_request).await?;
Ryan Olson's avatar
Ryan Olson committed
1292
1293
1294
        // Extract context once
        let context = response_stream.context();

1295
        // transform the postprocessor stream (no boxing yet) - detokenize
Ryan Olson's avatar
Ryan Olson committed
1296
1297
1298
1299
1300
1301
        let stream = Self::transform_postprocessor_stream(
            response_stream,
            response_generator,
            context.clone(),
        );

1302
1303
        let transformed_stream =
            self.postprocessor_parsing_stream(stream, &request, prompt_injected_reasoning)?;
Ryan Olson's avatar
Ryan Olson committed
1304

1305
1306
1307
        // Apply audit aggregation strategy.
        // The audit branch already returns Pin<Box<...>> from scan/fold_aggregate_with_future,
        // while the non-audit branch boxes the impl Stream from postprocessor_parsing_stream.
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
        let final_stream = if let Some(mut audit) = audit_handle {
            let (stream, agg_fut) = if audit.streaming() {
                // Streaming: apply scan (pass-through + parallel aggregation)
                crate::audit::stream::scan_aggregate_with_future(transformed_stream)
            } else {
                // Non-streaming: apply fold (collect all, then emit single chunk)
                crate::audit::stream::fold_aggregate_with_future(transformed_stream)
            };

            // Spawn audit task
            tokio::spawn(async move {
                let final_resp = agg_fut.await;
                audit.set_response(Arc::new(final_resp));
                audit.emit();
            });

1324
            stream
1325
        } else {
1326
            Box::pin(transformed_stream)
1327
1328
        };

Yan Ru Pei's avatar
Yan Ru Pei committed
1329
1330
1331
1332
1333
1334
1335
1336
1337
        // Step 5: Speculative next-turn prefill
        let final_stream = speculative_prefill::maybe_wrap_stream(
            final_stream,
            &request,
            &next,
            &self.formatter,
            &self.tokenizer,
        );

Biswa Panda's avatar
Biswa Panda committed
1338
        // prepend the annotations to the response stream
1339
        let stream = annotations_stream.chain(final_stream);
Biswa Panda's avatar
Biswa Panda committed
1340

Ryan Olson's avatar
Ryan Olson committed
1341
        // return the response stream - single boxing at the end
Biswa Panda's avatar
Biswa Panda committed
1342
1343
1344
1345
1346
1347
1348
        Ok(ResponseStream::new(Box::pin(stream), context))
    }
}

#[async_trait]
impl
    Operator<
1349
        SingleIn<NvCreateCompletionRequest>,
1350
        ManyOut<Annotated<NvCreateCompletionResponse>>,
1351
        SingleIn<PreprocessedRequest>,
Biswa Panda's avatar
Biswa Panda committed
1352
1353
1354
1355
1356
        ManyOut<Annotated<BackendOutput>>,
    > for OpenAIPreprocessor
{
    async fn generate(
        &self,
1357
        request: SingleIn<NvCreateCompletionRequest>,
Biswa Panda's avatar
Biswa Panda committed
1358
        next: Arc<
1359
            dyn AsyncEngine<SingleIn<PreprocessedRequest>, ManyOut<Annotated<BackendOutput>>, Error>,
Biswa Panda's avatar
Biswa Panda committed
1360
        >,
1361
    ) -> Result<ManyOut<Annotated<NvCreateCompletionResponse>>, Error> {
Biswa Panda's avatar
Biswa Panda committed
1362
        // unpack the request
1363
1364
        let (mut request, context) = request.into_parts();

1365
1366
1367
1368
1369
1370
1371
1372
        // Preserve original streaming flag
        let original_stream_flag = request.inner.stream.unwrap_or(false);

        // For non-streaming requests (stream=false), enable usage by default
        // This ensures compliance with OpenAI API spec where non-streaming responses
        // always include usage statistics
        request.enable_usage_for_nonstreaming(original_stream_flag);

1373
        request.inner.stream = Some(true);
Biswa Panda's avatar
Biswa Panda committed
1374
1375

        // create a response generator
1376
        let response_generator = request.response_generator(context.id().to_string());
Biswa Panda's avatar
Biswa Panda committed
1377
        let mut response_generator = Box::new(response_generator);
1378
        let tracker = response_generator.tracker();
Biswa Panda's avatar
Biswa Panda committed
1379
        // convert the chat completion request to a common completion request
1380
        let mut builder = self.builder(&request)?;
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390

        // Check if embeddings are provided - skip tokenization path
        let annotations = if let Some(ref prompt_embeds) = request.inner.prompt_embeds {
            // Skip tokenization for embeddings
            builder.token_ids(vec![]); // Empty token IDs
            builder.prompt_embeds(Some(prompt_embeds.clone()));
            // No token annotations
            HashMap::new()
        } else {
            // Normal path: tokenize the prompt
1391
            self.gather_tokens(&request, &mut builder, None, tracker.as_deref())?
1392
1393
1394
        };

        // Gather multimodal data (works with both embeddings and text prompts)
1395
1396
        self.gather_multi_modal_data(&request, &mut builder, None)
            .await?;
1397

1398
1399
1400
        let mut common_request = builder.build()?;

        // Attach the timing tracker to the request so downstream components can record metrics
1401
        common_request.tracker = tracker;
Biswa Panda's avatar
Biswa Panda committed
1402

1403
1404
1405
1406
1407
        // Update ISL only for text prompts (embeddings get sequence length from tensor shape)
        if common_request.prompt_embeds.is_none() {
            let isl = common_request.token_ids.len() as u32;
            response_generator.update_isl(isl);
        }
Biswa Panda's avatar
Biswa Panda committed
1408
1409
1410
1411
1412

        // repack the common completion request
        let common_request = context.map(|_| common_request);

        // create a stream of annotations this will be prepend to the response stream
1413
        let annotations: Vec<Annotated<NvCreateCompletionResponse>> = annotations
Biswa Panda's avatar
Biswa Panda committed
1414
1415
1416
1417
1418
1419
1420
1421
            .into_iter()
            .flat_map(|(k, v)| Annotated::from_annotation(k, &v))
            .collect();
        let annotations_stream = stream::iter(annotations);

        // forward the common completion request to the next operator
        let response_stream = next.generate(common_request).await?;

Ryan Olson's avatar
Ryan Olson committed
1422
1423
1424
        // Extract context once
        let context = response_stream.context();

Biswa Panda's avatar
Biswa Panda committed
1425
        // transform the postprocessor stream
Ryan Olson's avatar
Ryan Olson committed
1426
1427
1428
1429
1430
        let stream = Self::transform_postprocessor_stream(
            response_stream,
            response_generator,
            context.clone(),
        );
Biswa Panda's avatar
Biswa Panda committed
1431
1432
1433
1434
1435
1436
1437
1438

        // prepend the annotations to the response stream
        let stream = annotations_stream.chain(stream);

        // return the response stream
        Ok(ResponseStream::new(Box::pin(stream), context))
    }
}
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453

#[async_trait]
impl
    Operator<
        SingleIn<NvCreateEmbeddingRequest>,
        ManyOut<Annotated<NvCreateEmbeddingResponse>>,
        SingleIn<PreprocessedEmbeddingRequest>,
        ManyOut<Annotated<EmbeddingsEngineOutput>>,
    > for OpenAIPreprocessor
{
    async fn generate(
        &self,
        request: SingleIn<NvCreateEmbeddingRequest>,
        next: Arc<
            dyn AsyncEngine<
1454
1455
1456
1457
                    SingleIn<PreprocessedEmbeddingRequest>,
                    ManyOut<Annotated<EmbeddingsEngineOutput>>,
                    Error,
                >,
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
        >,
    ) -> Result<ManyOut<Annotated<NvCreateEmbeddingResponse>>, Error> {
        // Unpack request
        let (request, context) = request.into_parts();

        // Preprocess the embedding request
        let (preprocessed_request, annotations) =
            self.preprocess_embedding_request(&request).await?;

        // Forward to next stage
        let preprocessed_request = context.map(|_| preprocessed_request);
        let response_stream = next.generate(preprocessed_request).await?;

Ryan Olson's avatar
Ryan Olson committed
1471
1472
1473
        // Extract context once
        let context = response_stream.context();

1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
        // Transform response stream back to OpenAI format
        let stream = Self::transform_embedding_postprocessor_stream(response_stream, request);

        // Prepend annotations
        let annotations_stream = stream::iter(
            annotations
                .into_iter()
                .flat_map(|(k, v)| Annotated::from_annotation(k, &v))
                .collect::<Vec<_>>(),
        );

        let combined_stream = annotations_stream.chain(stream);
        Ok(ResponseStream::new(Box::pin(combined_stream), context))
    }
}
Ryan Olson's avatar
Ryan Olson committed
1489
1490

// Note: tests for jailing and parser detection live in `lib/llm/tests/test_jail.rs`
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_is_reasoning_disabled_by_request() {
        let thinking_true = {
            let mut m = std::collections::HashMap::new();
            m.insert("thinking".to_string(), serde_json::Value::Bool(true));
            m
        };
        let thinking_false = {
            let mut m = std::collections::HashMap::new();
            m.insert("thinking".to_string(), serde_json::Value::Bool(false));
            m
        };
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
        let enable_thinking_true = {
            let mut m = std::collections::HashMap::new();
            m.insert("enable_thinking".to_string(), serde_json::Value::Bool(true));
            m
        };
        let enable_thinking_false = {
            let mut m = std::collections::HashMap::new();
            m.insert(
                "enable_thinking".to_string(),
                serde_json::Value::Bool(false),
            );
            m
        };
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
        let thinking_mode_chat = {
            let mut m = std::collections::HashMap::new();
            m.insert(
                "thinking_mode".to_string(),
                serde_json::Value::String("chat".to_string()),
            );
            m
        };
        let thinking_mode_thinking = {
            let mut m = std::collections::HashMap::new();
            m.insert(
                "thinking_mode".to_string(),
                serde_json::Value::String("thinking".to_string()),
            );
            m
        };
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
        let empty_args = std::collections::HashMap::new();

        // (parser, args, expected_disabled, description)
        let cases = [
            (
                Some("kimi_k25"),
                Some(&thinking_false),
                true,
                "kimi_k25 + thinking=false → disabled",
            ),
            (
                Some("kimi_k25"),
                Some(&thinking_true),
                false,
                "kimi_k25 + thinking=true → enabled",
            ),
            (
                Some("kimi_k25"),
                None,
                false,
                "kimi_k25 + no args → enabled",
            ),
            (
                Some("kimi_k25"),
                Some(&empty_args),
                false,
                "kimi_k25 + empty args → enabled",
            ),
1565
            // deepseek_r1 uses "thinking" bool or "thinking_mode" string
1566
1567
1568
            (
                Some("deepseek_r1"),
                Some(&thinking_false),
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
                true,
                "deepseek_r1 + thinking=false → disabled",
            ),
            (
                Some("deepseek_r1"),
                Some(&thinking_true),
                false,
                "deepseek_r1 + thinking=true → enabled",
            ),
            (
                Some("deepseek_r1"),
                Some(&thinking_mode_chat),
                true,
                "deepseek_r1 + thinking_mode=chat → disabled",
            ),
            (
                Some("deepseek_r1"),
                Some(&thinking_mode_thinking),
                false,
                "deepseek_r1 + thinking_mode=thinking → enabled",
            ),
            (
                Some("deepseek_r1"),
                None,
                false,
                "deepseek_r1 + no args → enabled",
            ),
            (
                Some("deepseek_r1"),
                Some(&empty_args),
1599
                false,
1600
                "deepseek_r1 + empty args → enabled",
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
            ),
            (
                Some("basic"),
                Some(&thinking_false),
                false,
                "basic → never disabled",
            ),
            (
                None,
                Some(&thinking_false),
                false,
                "no parser → never disabled",
            ),
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
            // nemotron_nano uses "enable_thinking" key
            (
                Some("nemotron_nano"),
                Some(&enable_thinking_false),
                true,
                "nemotron_nano + enable_thinking=false → disabled",
            ),
            (
                Some("nemotron_nano"),
                Some(&enable_thinking_true),
                false,
                "nemotron_nano + enable_thinking=true → enabled",
            ),
            (
                Some("nemotron_nano"),
                None,
                false,
                "nemotron_nano + no args → enabled",
            ),
            (
                Some("nemotron_nano"),
                Some(&empty_args),
                false,
                "nemotron_nano + empty args → enabled",
            ),
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
        ];

        for (parser, args, expected, desc) in cases {
            assert_eq!(
                OpenAIPreprocessor::is_reasoning_disabled_by_request(parser, args),
                expected,
                "FAILED: {desc}",
            );
        }
    }
}