Skip to main content

objectiveai_sdk/cli/command/functions/execute/standard/
mod.rs

1//! `functions execute standard` — async handler stub.
2
3use crate::agent::completions::message::Message;  // unused placeholder to keep imports tidy
4use crate::cli::command::CommandRequest;
5use crate::functions::expression::InputValue;
6use super::{FunctionArgs, FunctionSpec, ProfileArgs, ProfileSpec};
7
8#[allow(dead_code)]
9type _UnusedMessage = Message;
10
11#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize, schemars::JsonSchema)]
12#[schemars(rename = "cli.command.functions.execute.standard.Request")]
13pub struct Request {
14    pub path_type: Path,
15    pub function: FunctionSpec,
16    pub profile: ProfileSpec,
17    pub input: RequestInput,
18    pub continuation: Option<String>,
19    pub split: bool,
20    pub invert: bool,
21    pub dangerous_advanced: Option<RequestDangerousAdvanced>,
22    #[serde(flatten)]
23    pub base: crate::cli::command::RequestBase,
24}
25
26#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize, schemars::JsonSchema)]
27#[schemars(rename = "cli.command.functions.execute.standard.Path")]
28pub enum Path {
29    #[serde(rename = "functions/execute/standard")]
30    FunctionsExecuteStandard,
31}
32
33#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize, schemars::JsonSchema)]
34#[schemars(rename = "cli.command.functions.execute.standard.RequestInput")]
35pub enum RequestInput {
36    #[schemars(title = "Inline")]
37    Inline(InputValue),
38    #[schemars(title = "File")]
39    File(std::path::PathBuf),
40    #[schemars(title = "PythonInline")]
41    PythonInline(String),
42    #[schemars(title = "PythonFile")]
43    PythonFile(std::path::PathBuf),
44}
45
46impl RequestInput {
47    fn push_flags(&self, out: &mut Vec<String>) {
48        match self {
49            RequestInput::Inline(v) => {
50                out.push("--input-inline".to_string());
51                out.push(serde_json::to_string(v).expect("input serializes"));
52            }
53            RequestInput::File(p) => {
54                out.push("--input-file".to_string());
55                out.push(p.to_string_lossy().into_owned());
56            }
57            RequestInput::PythonInline(code) => {
58                out.push("--input-python-inline".to_string());
59                out.push(code.clone());
60            }
61            RequestInput::PythonFile(p) => {
62                out.push("--input-python-file".to_string());
63                out.push(p.to_string_lossy().into_owned());
64            }
65        }
66    }
67}
68
69impl CommandRequest for Request {
70    fn into_command(&self) -> Vec<String> {
71        let mut argv = vec![
72            "functions".to_string(),
73            "execute".to_string(),
74            "standard".to_string(),
75        ];
76        self.function.push_flags(&mut argv);
77        self.profile.push_flags(&mut argv);
78        self.input.push_flags(&mut argv);
79        if let Some(c) = &self.continuation {
80            argv.push("--continuation".to_string());
81            argv.push(c.clone());
82        }
83        if self.split {
84            argv.push("--split".to_string());
85        }
86        if self.invert {
87            argv.push("--invert".to_string());
88        }
89        if let Some(advanced) = &self.dangerous_advanced {
90            argv.push("--dangerous-advanced".to_string());
91            argv.push(
92                serde_json::to_string(advanced)
93                    .expect("RequestDangerousAdvanced serializes"),
94            );
95        }
96        self.base.push_flags(&mut argv);
97        argv
98    }
99
100    fn request_base(&self) -> &crate::cli::command::RequestBase {
101        &self.base
102    }
103
104    fn request_base_mut(&mut self) -> Option<&mut crate::cli::command::RequestBase> {
105        Some(&mut self.base)
106    }
107}
108
109#[derive(Debug, Clone, Default, PartialEq, Eq, serde::Serialize, serde::Deserialize, schemars::JsonSchema)]
110#[schemars(rename = "cli.command.functions.execute.standard.RequestDangerousAdvanced")]
111pub struct RequestDangerousAdvanced {
112    #[serde(default, skip_serializing_if = "Option::is_none")]
113    #[schemars(extend("omitempty" = true))]
114    pub stream: Option<bool>,
115    /// Deterministic seed for downstream mock agents. Forwarded
116    /// to every per-task `AgentCompletionCreateParams.seed`.
117    #[serde(default, skip_serializing_if = "Option::is_none")]
118    #[schemars(extend("omitempty" = true))]
119    pub seed: Option<i64>,
120}
121
122#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize, schemars::JsonSchema)]
123#[serde(untagged)]
124#[schemars(rename = "cli.command.functions.execute.standard.ResponseItem")]
125pub enum ResponseItem {
126    #[schemars(title = "Chunk")]
127    Chunk(crate::functions::executions::response::streaming::FunctionExecutionChunk),
128    #[schemars(title = "Id")]
129    Id(String),
130}
131
132/// Non-chunk variant of [`ResponseItem`]. Returned by the unary `execute`
133/// path (with `dangerous_advanced.stream` cleared) when the cli emits a
134/// single bare id string.
135pub type Response = String;
136
137/// Exactly-one-of `--input-inline | --input-file | --input-python-inline
138/// | --input-python-file`. Scoped to its own `#[group]` annotation on a
139/// dedicated sub-struct so the `required = true, multiple = false`
140/// enforcement only applies to these fields — hoisting the annotation
141/// to the outer [`Args`] would pull every field into the "input_group"
142/// group via clap derive's default-group rule. Mirrors the
143/// `super::{FunctionArgs, ProfileArgs}` pattern.
144#[derive(clap::Args)]
145#[group(id = "input_group", required = true, multiple = false)]
146pub struct InputArgs {
147    /// Inline JSON input value.
148    #[arg(long, group = "input_group")]
149    pub input_inline: Option<String>,
150    /// Path to a JSON file containing the input value.
151    #[arg(long, group = "input_group")]
152    pub input_file: Option<std::path::PathBuf>,
153    /// Inline Python that produces the input value.
154    #[arg(long, group = "input_group")]
155    pub input_python_inline: Option<String>,
156    /// Path to a Python file that produces the input value.
157    #[arg(long, group = "input_group")]
158    pub input_python_file: Option<std::path::PathBuf>,
159}
160
161#[derive(clap::Args)]
162pub struct Args {
163    /// Exactly one of `--function`, `--function-inline`,
164    /// `--function-file`, `--function-python-inline`,
165    /// `--function-python-file`.
166    #[command(flatten)]
167    pub function: FunctionArgs,
168    /// Exactly one of `--profile`, `--profile-inline`,
169    /// `--profile-file`, `--profile-python-inline`,
170    /// `--profile-python-file`.
171    #[command(flatten)]
172    pub profile: ProfileArgs,
173    /// Exactly one of `--input-inline`, `--input-file`,
174    /// `--input-python-inline`, `--input-python-file`.
175    #[command(flatten)]
176    pub input: InputArgs,
177    /// Continuation token from a previous response.
178    #[arg(long)]
179    pub continuation: Option<String>,
180    /// Treat input as an array and execute once per element.
181    #[arg(long)]
182    pub split: bool,
183    /// Invert outputs after expressions evaluate.
184    #[arg(long)]
185    pub invert: bool,
186    /// Advanced opt-in flags as inline JSON.
187    #[arg(long)]
188    pub dangerous_advanced: Option<String>,
189    #[command(flatten)]
190    pub base: crate::cli::command::RequestBaseArgs,
191}
192
193#[derive(clap::Args)]
194#[command(args_conflicts_with_subcommands = true)]
195pub struct Command {
196    #[command(flatten)]
197    pub args: Args,
198    #[command(subcommand)]
199    pub schema: Option<Schema>,
200}
201
202#[derive(clap::Subcommand)]
203pub enum Schema {
204    /// Emit the JSON Schema for this leaf's `Request` type and exit.
205    RequestSchema(request_schema::Args),
206    /// Emit the JSON Schema for this leaf's `Response` type and exit.
207    ResponseSchema(response_schema::Args),
208}
209
210impl TryFrom<Args> for Request {
211    type Error = crate::cli::command::FromArgsError;
212    fn try_from(args: Args) -> Result<Self, Self::Error> {
213        let function = FunctionSpec::try_from(args.function)?;
214        let profile = ProfileSpec::try_from(args.profile)?;
215        let input = if let Some(s) = args.input.input_inline {
216            let mut de = serde_json::Deserializer::from_str(&s);
217            let v = serde_path_to_error::deserialize(&mut de)
218                .map_err(|e| crate::cli::command::FromArgsError::json("input_inline", e))?;
219            RequestInput::Inline(v)
220        } else if let Some(p) = args.input.input_file {
221            RequestInput::File(p)
222        } else if let Some(s) = args.input.input_python_inline {
223            RequestInput::PythonInline(s)
224        } else {
225            RequestInput::PythonFile(args.input.input_python_file.unwrap())
226        };
227        let dangerous_advanced: Option<RequestDangerousAdvanced> =
228            if let Some(s) = args.dangerous_advanced {
229                let mut de = serde_json::Deserializer::from_str(&s);
230                let v = serde_path_to_error::deserialize(&mut de)
231                    .map_err(|e| crate::cli::command::FromArgsError::json("dangerous_advanced", e))?;
232                Some(v)
233            } else {
234                None
235            };
236        Ok(Self { path_type: Path::FunctionsExecuteStandard,
237            function,
238            profile,
239            input,
240            continuation: args.continuation,
241            split: args.split,
242            invert: args.invert,
243            dangerous_advanced,
244            base: args.base.into(),
245        })
246    }
247}
248
249#[cfg(feature = "cli-executor")]
250pub async fn execute_streaming<E: crate::cli::command::CommandExecutor>(
251    executor: &E,
252    mut request: Request,
253
254        agent_arguments: Option<&crate::cli::command::AgentArguments>,
255    ) -> Result<E::Stream<ResponseItem>, E::Error> {
256    request.base.clear_transform();
257    let mut advanced = request.dangerous_advanced.unwrap_or_default();
258    advanced.stream = Some(true);
259    request.dangerous_advanced = Some(advanced);
260    executor.execute(request, agent_arguments).await
261}
262
263#[cfg(feature = "cli-executor")]
264pub async fn execute_streaming_transform<E: crate::cli::command::CommandExecutor>(
265    executor: &E,
266    mut request: Request,
267    transform: crate::cli::command::Transform,
268
269        agent_arguments: Option<&crate::cli::command::AgentArguments>,
270    ) -> Result<E::Stream<serde_json::Value>, E::Error> {
271    request.base.set_transform(transform);
272    let mut advanced = request.dangerous_advanced.unwrap_or_default();
273    advanced.stream = Some(true);
274    request.dangerous_advanced = Some(advanced);
275    executor.execute(request, agent_arguments).await
276}
277
278#[cfg(feature = "cli-executor")]
279pub async fn execute<E: crate::cli::command::CommandExecutor>(
280    executor: &E,
281    mut request: Request,
282
283        agent_arguments: Option<&crate::cli::command::AgentArguments>,
284    ) -> Result<Response, E::Error> {
285    request.base.clear_transform();
286    if let Some(advanced) = request.dangerous_advanced.as_mut() {
287        advanced.stream = None;
288    }
289    executor.execute_one(request, agent_arguments).await
290}
291
292#[cfg(feature = "cli-executor")]
293pub async fn execute_transform<E: crate::cli::command::CommandExecutor>(
294    executor: &E,
295    mut request: Request,
296    transform: crate::cli::command::Transform,
297
298        agent_arguments: Option<&crate::cli::command::AgentArguments>,
299    ) -> Result<serde_json::Value, E::Error> {
300    request.base.set_transform(transform);
301    if let Some(advanced) = request.dangerous_advanced.as_mut() {
302        advanced.stream = None;
303    }
304    executor.execute_one(request, agent_arguments).await
305}
306
307#[cfg(feature = "mcp")]
308impl crate::cli::command::CommandResponse for ResponseItem {
309    fn into_mcp(self) -> crate::cli::command::McpResponseItem {
310        crate::cli::command::McpResponseItem::JSONL(serde_json::to_value(self).unwrap())
311    }
312}
313
314pub mod request_schema;
315
316
317pub mod response_schema;