Struct ChatExtras 

#[non_exhaustive]
pub struct ChatExtras {
    pub entropy: Option<f64>,
}

Per-call extras returned alongside the chat response by LlmProvider::chat_with_extras.

Always paired 1:1 with a single response — no shared state, no races possible. All optional fields default to None so providers that do not expose the underlying API (e.g. Claude, Gemini) can simply return the default.

Marked #[non_exhaustive] so future fields (e.g. cached_tokens) can be added without breaking match sites.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

entropy: Option<f64>

Mean negative log-probability of the generated tokens, when the provider was configured to request logprobs and the API supplied them.

Lower = more confident. Typical range: [0.0, ~6.0] for natural-language tokens.

Implementations

impl ChatExtras

pub fn with_entropy(entropy: f64) -> Self

Return a ChatExtras with the given entropy value.

Used by MockProvider (test-only, enabled via testing feature) and OpenAI/Ollama providers.

Examples

use zeph_llm::provider::ChatExtras;

let extras = ChatExtras::with_entropy(0.9);
assert_eq!(extras.entropy, Some(0.9));

Trait Implementations

impl Clone for ChatExtras

fn clone(&self) -> ChatExtras

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatExtras

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

Formats the value using the given formatter.

impl Default for ChatExtras

fn default() -> ChatExtras

Returns the “default value” for a type.