// SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. // SPDX-License-Identifier: Apache-2.0 use super::{NvCreateChatCompletionRequest, NvCreateChatCompletionStreamResponse}; use crate::{ local_model::runtime_config::ModelRuntimeConfig, protocols::common::{self}, types::TokenIdType, }; /// Provides a method for generating a [`DeltaGenerator`] from a chat completion request. impl NvCreateChatCompletionRequest { /// Enables usage tracking for non-streaming requests to comply with OpenAI API specification. /// /// According to OpenAI API spec, non-streaming chat completion responses (stream=false) /// must always include usage statistics. This method ensures `stream_options.include_usage` /// is set to `true` for non-streaming requests. /// /// # Arguments /// * `original_stream_flag` - The original value of the `stream` field before any internal processing pub fn enable_usage_for_nonstreaming(&mut self, original_stream_flag: bool) { if !original_stream_flag { // For non-streaming requests (stream=false), enable usage by default if self.inner.stream_options.is_none() { self.inner.stream_options = Some(dynamo_async_openai::types::ChatCompletionStreamOptions { include_usage: true, }); } else if let Some(ref mut opts) = self.inner.stream_options { // If stream_options exists, ensure include_usage is true for non-streaming opts.include_usage = true; } } } /// Creates a [`DeltaGenerator`] instance based on the chat completion request. /// /// # Arguments /// * `request_id` - The request ID to use for the chat completion response ID. /// /// # Returns /// * [`DeltaGenerator`] configured with model name and response options. pub fn response_generator(&self, request_id: String) -> DeltaGenerator { let options = DeltaGeneratorOptions { enable_usage: self .inner .stream_options .as_ref() .map(|opts| opts.include_usage) .unwrap_or(false), enable_logprobs: self.inner.logprobs.unwrap_or(false) || self.inner.top_logprobs.unwrap_or(0) > 0, runtime_config: ModelRuntimeConfig::default(), }; DeltaGenerator::new(self.inner.model.clone(), options, request_id) } } /// Configuration options for the [`DeltaGenerator`], controlling response behavior. #[derive(Debug, Clone, Default)] pub struct DeltaGeneratorOptions { /// Determines whether token usage statistics should be included in the response. pub enable_usage: bool, /// Determines whether log probabilities should be included in the response. pub enable_logprobs: bool, pub runtime_config: ModelRuntimeConfig, } /// Generates incremental chat completion responses in a streaming fashion. #[derive(Debug)] pub struct DeltaGenerator { /// Unique identifier for the chat completion session. id: String, /// Object type, representing a streamed chat completion response. object: String, /// Timestamp (Unix epoch) when the response was created. created: u32, model: String, /// Optional system fingerprint for version tracking. system_fingerprint: Option, /// Optional service tier information for the response. service_tier: Option, /// Tracks token usage for the completion request. usage: dynamo_async_openai::types::CompletionUsage, /// Counter tracking the number of messages issued. msg_counter: u64, /// Configuration options for response generation. options: DeltaGeneratorOptions, } impl DeltaGenerator { /// Creates a new [`DeltaGenerator`] instance with the specified model and options. /// /// # Arguments /// * `model` - The model name used for response generation. /// * `options` - Configuration options for enabling usage and log probabilities. /// * `request_id` - The request ID to use for the chat completion response. /// /// # Returns /// * A new instance of [`DeltaGenerator`]. pub fn new(model: String, options: DeltaGeneratorOptions, request_id: String) -> Self { let now = std::time::SystemTime::now() .duration_since(std::time::UNIX_EPOCH) .unwrap() .as_secs(); // SAFETY: Casting from `u64` to `u32` could lead to precision loss after `u32::MAX`, // but this will not be an issue until 2106. let now: u32 = now.try_into().expect("timestamp exceeds u32::MAX"); let usage = dynamo_async_openai::types::CompletionUsage { prompt_tokens: 0, completion_tokens: 0, total_tokens: 0, prompt_tokens_details: None, completion_tokens_details: None, }; let chatcmpl_id = format!("chatcmpl-{request_id}"); Self { id: chatcmpl_id, object: "chat.completion.chunk".to_string(), created: now, model, system_fingerprint: None, service_tier: None, usage, msg_counter: 0, options, } } /// Updates the prompt token usage count. /// /// # Arguments /// * `isl` - The number of prompt tokens used. pub fn update_isl(&mut self, isl: u32) { self.usage.prompt_tokens = isl; } pub fn create_logprobs( &self, tokens: Vec, token_ids: &[TokenIdType], logprobs: Option, top_logprobs: Option, ) -> Option { if !self.options.enable_logprobs || logprobs.is_none() { return None; } let toks = tokens .into_iter() .zip(token_ids) .map(|(token, token_id)| (token.unwrap_or_default(), *token_id)) .collect::>(); let tok_lps = toks .iter() .zip(logprobs.unwrap()) .map(|(_, lp)| lp as f32) .collect::>(); let content = top_logprobs.map(|top_logprobs| { toks.iter() .zip(tok_lps) .zip(top_logprobs) .map(|(((t, tid), lp), top_lps)| { let mut found_selected_token = false; let mut converted_top_lps = top_lps .iter() .map(|top_lp| { let top_t = top_lp.token.clone().unwrap_or_default(); let top_tid = top_lp.token_id; found_selected_token = found_selected_token || top_tid == *tid; dynamo_async_openai::types::TopLogprobs { token: top_t, logprob: top_lp.logprob as f32, bytes: None, } }) .collect::>(); if !found_selected_token { // If the selected token is not in the top logprobs, add it converted_top_lps.push(dynamo_async_openai::types::TopLogprobs { token: t.clone(), logprob: lp, bytes: None, }); } dynamo_async_openai::types::ChatCompletionTokenLogprob { token: t.clone(), logprob: lp, bytes: None, top_logprobs: converted_top_lps, } }) .collect() }); Some(dynamo_async_openai::types::ChatChoiceLogprobs { content, refusal: None, }) } /// Creates a choice within a chat completion response. /// /// # Arguments /// * `index` - The index of the choice in the completion response. /// * `text` - The text content for the response. /// * `finish_reason` - The reason why the response finished (e.g., stop, length, etc.). /// * `logprobs` - Optional log probabilities of the generated tokens. /// /// # Returns /// * An [`dynamo_async_openai::types::CreateChatCompletionStreamResponse`] instance representing the choice. #[allow(deprecated)] pub fn create_choice( &mut self, index: u32, text: Option, finish_reason: Option, logprobs: Option, ) -> NvCreateChatCompletionStreamResponse { let delta = dynamo_async_openai::types::ChatCompletionStreamResponseDelta { content: text, function_call: None, tool_calls: None, role: if self.msg_counter == 0 { Some(dynamo_async_openai::types::Role::Assistant) } else { None }, refusal: None, reasoning_content: None, }; let choice = dynamo_async_openai::types::ChatChoiceStream { index, delta, finish_reason, logprobs, }; let choices = vec![choice]; // According to OpenAI spec: when stream_options.include_usage is true, // all intermediate chunks should have usage: null // The final usage chunk will be sent separately with empty choices dynamo_async_openai::types::CreateChatCompletionStreamResponse { id: self.id.clone(), object: self.object.clone(), created: self.created, model: self.model.clone(), system_fingerprint: self.system_fingerprint.clone(), choices, usage: None, // Always None for chunks with content/choices service_tier: self.service_tier.clone(), } } /// Creates a final usage-only chunk for OpenAI compliance. /// This should be sent after the last content chunk when stream_options.include_usage is true. /// /// # Returns /// * A [`CreateChatCompletionStreamResponse`] with empty choices and usage stats. pub fn create_usage_chunk(&self) -> NvCreateChatCompletionStreamResponse { let mut usage = self.usage.clone(); usage.total_tokens = usage.prompt_tokens.saturating_add(usage.completion_tokens); dynamo_async_openai::types::CreateChatCompletionStreamResponse { id: self.id.clone(), object: self.object.clone(), created: self.created, model: self.model.clone(), system_fingerprint: self.system_fingerprint.clone(), choices: vec![], // Empty choices for usage-only chunk usage: Some(usage), service_tier: self.service_tier.clone(), } } /// Check if usage tracking is enabled pub fn is_usage_enabled(&self) -> bool { self.options.enable_usage } } /// Implements the [`crate::protocols::openai::DeltaGeneratorExt`] trait for [`DeltaGenerator`], allowing /// it to transform backend responses into OpenAI-style streaming responses. impl crate::protocols::openai::DeltaGeneratorExt for DeltaGenerator { /// Converts a backend response into a structured OpenAI-style streaming response. /// /// # Arguments /// * `delta` - The backend response containing generated text and metadata. /// /// # Returns /// * `Ok(NvCreateChatCompletionStreamResponse)` if conversion succeeds. /// * `Err(anyhow::Error)` if an error occurs. fn choice_from_postprocessor( &mut self, delta: crate::protocols::common::llm_backend::BackendOutput, ) -> anyhow::Result { // Aggregate token usage if enabled. if self.options.enable_usage { // SAFETY: Casting from `usize` to `u32` could lead to precision loss after `u32::MAX`, // but this will not be an issue until context lengths exceed 4_294_967_295. let token_length: u32 = delta .token_ids .len() .try_into() .expect("token_ids length exceeds u32::MAX"); self.usage.completion_tokens += token_length; // If backend provides completion_usage with prompt token details, // propagate the entire details struct to usage tracking if let Some(prompt_details) = delta .completion_usage .as_ref() .and_then(|usage| usage.prompt_tokens_details.as_ref()) { self.usage.prompt_tokens_details = Some(prompt_details.clone()); } } let logprobs = self.create_logprobs( delta.tokens, &delta.token_ids, delta.log_probs, delta.top_logprobs, ); // Map backend finish reasons to OpenAI's finish reasons. let finish_reason = match delta.finish_reason { Some(common::FinishReason::EoS) => Some(dynamo_async_openai::types::FinishReason::Stop), Some(common::FinishReason::Stop) => { Some(dynamo_async_openai::types::FinishReason::Stop) } Some(common::FinishReason::Length) => { Some(dynamo_async_openai::types::FinishReason::Length) } Some(common::FinishReason::Cancelled) => { Some(dynamo_async_openai::types::FinishReason::Stop) } Some(common::FinishReason::ContentFilter) => { Some(dynamo_async_openai::types::FinishReason::ContentFilter) } Some(common::FinishReason::Error(err_msg)) => { return Err(anyhow::anyhow!(err_msg)); } None => None, }; // Create the streaming response. let index = 0; let stream_response = self.create_choice(index, delta.text, finish_reason, logprobs); Ok(stream_response) } fn get_isl(&self) -> Option { Some(self.usage.prompt_tokens) } fn create_usage_chunk(&self) -> NvCreateChatCompletionStreamResponse { DeltaGenerator::create_usage_chunk(self) } fn is_usage_enabled(&self) -> bool { DeltaGenerator::is_usage_enabled(self) } } #[cfg(test)] mod tests { use super::*; use dynamo_async_openai::types::{ ChatCompletionRequestMessage, ChatCompletionRequestUserMessage, ChatCompletionRequestUserMessageContent, CreateChatCompletionRequest, }; fn create_test_request() -> NvCreateChatCompletionRequest { let messages = vec![ChatCompletionRequestMessage::User( ChatCompletionRequestUserMessage { content: ChatCompletionRequestUserMessageContent::Text("test".to_string()), name: None, }, )]; NvCreateChatCompletionRequest { inner: CreateChatCompletionRequest { model: "test-model".to_string(), messages, stream: Some(false), stream_options: None, ..Default::default() }, common: Default::default(), nvext: None, chat_template_args: None, unsupported_fields: Default::default(), } } #[test] fn test_enable_usage_for_nonstreaming_enables_usage() { // Test that non-streaming requests get usage enabled let mut request = create_test_request(); assert!(request.inner.stream_options.is_none()); request.enable_usage_for_nonstreaming(false); // false = non-streaming assert!( request.inner.stream_options.is_some(), "Non-streaming request should have stream_options created" ); assert!( request.inner.stream_options.unwrap().include_usage, "Non-streaming request should have include_usage=true for OpenAI compliance" ); } #[test] fn test_enable_usage_for_nonstreaming_ignores_streaming() { // Test that streaming requests are not modified let mut request = create_test_request(); assert!(request.inner.stream_options.is_none()); request.enable_usage_for_nonstreaming(true); // true = streaming assert!( request.inner.stream_options.is_none(), "Streaming request should not have stream_options modified" ); } }