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 request_base(&self) -> &crate::cli::command::RequestBase {
71        &self.base
72    }
73
74    fn request_base_mut(&mut self) -> Option<&mut crate::cli::command::RequestBase> {
75        Some(&mut self.base)
76    }
77}
78
79#[derive(Debug, Clone, Default, PartialEq, Eq, serde::Serialize, serde::Deserialize, schemars::JsonSchema)]
80#[schemars(rename = "cli.command.functions.execute.standard.RequestDangerousAdvanced")]
81pub struct RequestDangerousAdvanced {
82    #[serde(default, skip_serializing_if = "Option::is_none")]
83    #[schemars(extend("omitempty" = true))]
84    pub stream: Option<bool>,
85    /// Deterministic seed for downstream mock agents. Forwarded
86    /// to every per-task `AgentCompletionCreateParams.seed`.
87    #[serde(default, skip_serializing_if = "Option::is_none")]
88    #[schemars(extend("omitempty" = true))]
89    pub seed: Option<i64>,
90}
91
92#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize, schemars::JsonSchema)]
93#[serde(untagged)]
94#[schemars(rename = "cli.command.functions.execute.standard.ResponseItem")]
95pub enum ResponseItem {
96    #[schemars(title = "Chunk")]
97    Chunk(crate::functions::executions::response::streaming::FunctionExecutionChunk),
98    #[schemars(title = "Id")]
99    Id(String),
100}
101
102/// Non-chunk variant of [`ResponseItem`]. Returned by the unary `execute`
103/// path (with `dangerous_advanced.stream` cleared) when the cli emits a
104/// single bare id string.
105pub type Response = String;
106
107/// Exactly-one-of `--input-inline | --input-file | --input-python-inline
108/// | --input-python-file`. Scoped to its own `#[group]` annotation on a
109/// dedicated sub-struct so the `required = true, multiple = false`
110/// enforcement only applies to these fields — hoisting the annotation
111/// to the outer [`Args`] would pull every field into the "input_group"
112/// group via clap derive's default-group rule. Mirrors the
113/// `super::{FunctionArgs, ProfileArgs}` pattern.
114#[derive(clap::Args)]
115#[group(id = "input_group", required = true, multiple = false)]
116pub struct InputArgs {
117    /// Inline JSON input value.
118    #[arg(long, group = "input_group")]
119    pub input_inline: Option<String>,
120    /// Path to a JSON file containing the input value.
121    #[arg(long, group = "input_group")]
122    pub input_file: Option<std::path::PathBuf>,
123    /// Inline Python that produces the input value.
124    #[arg(long, group = "input_group")]
125    pub input_python_inline: Option<String>,
126    /// Path to a Python file that produces the input value.
127    #[arg(long, group = "input_group")]
128    pub input_python_file: Option<std::path::PathBuf>,
129}
130
131#[derive(clap::Args)]
132pub struct Args {
133    /// Exactly one of `--function`, `--function-inline`,
134    /// `--function-file`, `--function-python-inline`,
135    /// `--function-python-file`.
136    #[command(flatten)]
137    pub function: FunctionArgs,
138    /// Exactly one of `--profile`, `--profile-inline`,
139    /// `--profile-file`, `--profile-python-inline`,
140    /// `--profile-python-file`.
141    #[command(flatten)]
142    pub profile: ProfileArgs,
143    /// Exactly one of `--input-inline`, `--input-file`,
144    /// `--input-python-inline`, `--input-python-file`.
145    #[command(flatten)]
146    pub input: InputArgs,
147    /// Continuation token from a previous response.
148    #[arg(long)]
149    pub continuation: Option<String>,
150    /// Treat input as an array and execute once per element.
151    #[arg(long)]
152    pub split: bool,
153    /// Invert outputs after expressions evaluate.
154    #[arg(long)]
155    pub invert: bool,
156    /// Advanced opt-in flags as inline JSON.
157    #[arg(long)]
158    pub dangerous_advanced: Option<String>,
159    #[command(flatten)]
160    pub base: crate::cli::command::RequestBaseArgs,
161}
162
163#[derive(clap::Args)]
164#[command(args_conflicts_with_subcommands = true)]
165pub struct Command {
166    #[command(flatten)]
167    pub args: Args,
168    #[command(subcommand)]
169    pub schema: Option<Schema>,
170}
171
172#[derive(clap::Subcommand)]
173pub enum Schema {
174    /// Emit the JSON Schema for this leaf's `Request` type and exit.
175    RequestSchema(request_schema::Args),
176    /// Emit the JSON Schema for this leaf's `Response` type and exit.
177    ResponseSchema(response_schema::Args),
178}
179
180impl TryFrom<Args> for Request {
181    type Error = crate::cli::command::FromArgsError;
182    fn try_from(args: Args) -> Result<Self, Self::Error> {
183        let function = FunctionSpec::try_from(args.function)?;
184        let profile = ProfileSpec::try_from(args.profile)?;
185        let input = if let Some(s) = args.input.input_inline {
186            let mut de = serde_json::Deserializer::from_str(&s);
187            let v = serde_path_to_error::deserialize(&mut de)
188                .map_err(|e| crate::cli::command::FromArgsError::json("input_inline", e))?;
189            RequestInput::Inline(v)
190        } else if let Some(p) = args.input.input_file {
191            RequestInput::File(p)
192        } else if let Some(s) = args.input.input_python_inline {
193            RequestInput::PythonInline(s)
194        } else {
195            RequestInput::PythonFile(args.input.input_python_file.unwrap())
196        };
197        let dangerous_advanced: Option<RequestDangerousAdvanced> =
198            if let Some(s) = args.dangerous_advanced {
199                let mut de = serde_json::Deserializer::from_str(&s);
200                let v = serde_path_to_error::deserialize(&mut de)
201                    .map_err(|e| crate::cli::command::FromArgsError::json("dangerous_advanced", e))?;
202                Some(v)
203            } else {
204                None
205            };
206        Ok(Self { path_type: Path::FunctionsExecuteStandard,
207            function,
208            profile,
209            input,
210            continuation: args.continuation,
211            split: args.split,
212            invert: args.invert,
213            dangerous_advanced,
214            base: args.base.into(),
215        })
216    }
217}
218
219#[cfg(feature = "cli-executor")]
220pub async fn execute_streaming<E: crate::cli::command::CommandExecutor>(
221    executor: &E,
222    mut request: Request,
223
224        agent_arguments: Option<&crate::cli::command::AgentArguments>,
225    ) -> Result<E::Stream<ResponseItem>, E::Error> {
226    request.base.clear_transform();
227    let mut advanced = request.dangerous_advanced.unwrap_or_default();
228    advanced.stream = Some(true);
229    request.dangerous_advanced = Some(advanced);
230    executor.execute(request, agent_arguments).await
231}
232
233#[cfg(feature = "cli-executor")]
234pub async fn execute_streaming_transform<E: crate::cli::command::CommandExecutor>(
235    executor: &E,
236    mut request: Request,
237    transform: crate::cli::command::Transform,
238
239        agent_arguments: Option<&crate::cli::command::AgentArguments>,
240    ) -> Result<E::Stream<serde_json::Value>, E::Error> {
241    request.base.set_transform(transform);
242    let mut advanced = request.dangerous_advanced.unwrap_or_default();
243    advanced.stream = Some(true);
244    request.dangerous_advanced = Some(advanced);
245    executor.execute(request, agent_arguments).await
246}
247
248#[cfg(feature = "cli-executor")]
249pub async fn execute<E: crate::cli::command::CommandExecutor>(
250    executor: &E,
251    mut request: Request,
252
253        agent_arguments: Option<&crate::cli::command::AgentArguments>,
254    ) -> Result<Response, E::Error> {
255    request.base.clear_transform();
256    if let Some(advanced) = request.dangerous_advanced.as_mut() {
257        advanced.stream = None;
258    }
259    executor.execute_one(request, agent_arguments).await
260}
261
262#[cfg(feature = "cli-executor")]
263pub async fn execute_transform<E: crate::cli::command::CommandExecutor>(
264    executor: &E,
265    mut request: Request,
266    transform: crate::cli::command::Transform,
267
268        agent_arguments: Option<&crate::cli::command::AgentArguments>,
269    ) -> Result<serde_json::Value, E::Error> {
270    request.base.set_transform(transform);
271    if let Some(advanced) = request.dangerous_advanced.as_mut() {
272        advanced.stream = None;
273    }
274    executor.execute_one(request, agent_arguments).await
275}
276
277#[cfg(feature = "mcp")]
278impl crate::cli::command::CommandResponse for ResponseItem {
279    fn into_mcp(self) -> crate::cli::command::McpResponseItem {
280        crate::cli::command::McpResponseItem::JSONL(serde_json::to_value(self).unwrap())
281    }
282}
283
284pub mod request_schema;
285
286
287pub mod response_schema;