openai-client-base 0.12.0

Auto-generated Rust client for the OpenAI API
/*
 * OpenAI API
 *
 * The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
 *
 * The version of the OpenAPI document: 2.3.0
 *
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use serde::{Deserialize, Serialize};

/// ResponseLogProb : A logprob is the logarithmic probability that the model assigns to producing  a particular token at a given position in the sequence. Less-negative (higher)  logprob values indicate greater model confidence in that token choice.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct ResponseLogProb {
    /// A possible text token.
    #[serde(rename = "token")]
    pub token: String,
    /// The log probability of this token.
    #[serde(rename = "logprob")]
    pub logprob: f64,
    /// The log probability of the top 20 most likely tokens.
    #[serde(rename = "top_logprobs", skip_serializing_if = "Option::is_none")]
    pub top_logprobs: Option<Vec<models::ResponseLogProbTopLogprobsInner>>,
}

impl ResponseLogProb {
    /// A logprob is the logarithmic probability that the model assigns to producing  a particular token at a given position in the sequence. Less-negative (higher)  logprob values indicate greater model confidence in that token choice.
    pub fn new(token: String, logprob: f64) -> ResponseLogProb {
        ResponseLogProb {
            token,
            logprob,
            top_logprobs: None,
        }
    }
}

impl std::fmt::Display for ResponseLogProb {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match serde_json::to_string(self) {
            Ok(s) => write!(f, "{}", s),
            Err(_) => Err(std::fmt::Error),
        }
    }
}