objectiveai-sdk 2.2.11

ObjectiveAI SDK, definitions, and utilities
Documentation 
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

//! Complete function execution response.

use crate::{
    agent, error,
    functions::{self, executions::response},
};
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// A complete function execution response (non-streaming).
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[schemars(rename = "functions.executions.response.unary.FunctionExecution")]
pub struct FunctionExecution {
    /// Unique identifier for this execution.
    pub id: String,
    /// Results from each task in the function.
    pub tasks: Vec<super::Task>,
    /// Whether any tasks encountered errors.
    pub tasks_errors: bool,
    /// Reasoning summary if reasoning was enabled.
    pub reasoning: Option<super::ReasoningSummary>,
    /// The final output (scalar or vector score).
    pub output: super::super::Output,
    /// Error details if the execution failed.
    pub error: Option<error::ResponseError>,
    /// Unix timestamp when the execution was created.
    pub created: u64,
    /// The function used (if remote).
    pub function: Option<crate::RemotePath>,
    /// The profile used (if remote).
    pub profile: Option<crate::RemotePath>,
    /// Object type identifier.
    pub object: super::Object,
    /// Aggregated token and cost usage.
    pub usage: agent::completions::response::Usage,
}

impl FunctionExecution {
    pub fn any_usage(&self) -> bool {
        self.usage.any_usage()
    }

    /// Normalize non-deterministic fields for test snapshot comparison.
    pub fn normalize_for_tests(&mut self) {
        self.id = String::new();
        self.created = 0;
        self.usage.normalize_for_tests();
        for task in &mut self.tasks {
            match task {
                super::Task::VectorCompletion(vt) => {
                    // `index` reflects arrival order from concurrent
                    // sub-task streams, which is non-deterministic;
                    // pin it to the local sibling position (the last
                    // element of `task_path`) for snapshot stability.
                    vt.index = vt.task_path.last().copied().unwrap_or(0);
                    vt.inner.normalize_for_tests();
                }
                super::Task::FunctionExecution(ft) => {
                    ft.index = ft.task_path.last().copied().unwrap_or(0);
                    ft.inner.normalize_for_tests();
                }
            }
        }
        self.tasks.sort_by_cached_key(|t| t.snapshot_sort_key());
    }
}

impl From<response::streaming::FunctionExecutionChunk> for FunctionExecution {
    fn from(
        response::streaming::FunctionExecutionChunk {
            id,
            tasks,
            tasks_errors,
            reasoning,
            output,
            error,
            created,
            function,
            profile,
            object,
            usage,
        }: response::streaming::FunctionExecutionChunk,
    ) -> Self {
        Self {
            id,
            tasks: tasks.into_iter().map(super::Task::from).collect(),
            tasks_errors: tasks_errors.unwrap_or(false),
            reasoning: reasoning.map(super::ReasoningSummary::from),
            output: output.unwrap_or(response::Output {
                output: functions::expression::TaskOutputOwned::Err {
                    error: serde_json::Value::Null,
                },
            }),
            error,
            created,
            function,
            profile,
            object: object.into(),
            usage: usage.unwrap_or_default(),
        }
    }
}