openai-client-base 0.12.0

Auto-generated Rust client for the OpenAI API
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

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

/// FunctionShellAction : Execute a shell command.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct FunctionShellAction {
    #[serde(rename = "commands")]
    pub commands: Vec<String>,
    /// Optional timeout in milliseconds for the commands.
    #[serde(rename = "timeout_ms", deserialize_with = "Option::deserialize")]
    pub timeout_ms: Option<i32>,
    /// Optional maximum number of characters to return from each command.
    #[serde(rename = "max_output_length", deserialize_with = "Option::deserialize")]
    pub max_output_length: Option<i32>,
}

impl FunctionShellAction {
    /// Execute a shell command.
    pub fn new(
        commands: Vec<String>,
        timeout_ms: Option<i32>,
        max_output_length: Option<i32>,
    ) -> FunctionShellAction {
        FunctionShellAction {
            commands,
            timeout_ms,
            max_output_length,
        }
    }
}

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