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};

/// FunctionShellActionParam : Commands and limits describing how to run the shell tool call.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct FunctionShellActionParam {
    /// Ordered shell commands for the execution environment to run.
    #[serde(rename = "commands")]
    pub commands: Vec<String>,
    /// Maximum wall-clock time in milliseconds to allow the shell commands to run.
    #[serde(
        rename = "timeout_ms",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub timeout_ms: Option<Option<i32>>,
    /// Maximum number of UTF-8 characters to capture from combined stdout and stderr output.
    #[serde(
        rename = "max_output_length",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub max_output_length: Option<Option<i32>>,
}

impl FunctionShellActionParam {
    /// Commands and limits describing how to run the shell tool call.
    pub fn new(commands: Vec<String>) -> FunctionShellActionParam {
        FunctionShellActionParam {
            commands,
            timeout_ms: None,
            max_output_length: None,
        }
    }
}

impl std::fmt::Display for FunctionShellActionParam {
    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),
        }
    }
}