Skip to main content

objectiveai_sdk/vector/completions/response/unary/
vector_completion.rs

1//! Unary (non-streaming) vector completion response.
2
3use crate::{agent, vector::completions::response};
4use schemars::JsonSchema;
5use serde::{Deserialize, Serialize};
6
7/// A complete vector completion response (non-streaming).
8///
9/// Contains the final scores, all votes from the swarm, and the underlying
10/// agent completions that produced those votes.
11#[derive(Debug, Clone, Serialize, Deserialize, Default, JsonSchema)]
12#[schemars(rename = "vector.completions.response.unary.VectorCompletion")]
13pub struct VectorCompletion {
14    /// Unique identifier for this vector completion.
15    pub id: String,
16    /// The underlying agent completions from each agent in the swarm.
17    pub completions: Vec<super::AgentCompletion>,
18    /// Individual votes from each agent, showing their selections.
19    pub votes: Vec<response::Vote>,
20    /// Final weighted scores for each response option. Sums to 1.
21    #[serde(deserialize_with = "crate::serde_util::vec_decimal")]
22    #[schemars(with = "Vec<f64>")]
23    pub scores: Vec<rust_decimal::Decimal>,
24    /// Total weight allocated to each response option. Same length as `scores`.
25    /// For discrete votes, an LLM's full weight goes to its selected response.
26    /// For probabilistic votes, the weight is divided according to the distribution.
27    #[serde(deserialize_with = "crate::serde_util::vec_decimal")]
28    #[schemars(with = "Vec<f64>")]
29    pub weights: Vec<rust_decimal::Decimal>,
30    /// Unix timestamp when the completion was created.
31    pub created: u64,
32    /// ID of the swarm used for this completion.
33    pub swarm: String,
34    /// Object type identifier (`"vector.completion"`).
35    pub object: super::Object,
36    /// Aggregated token and cost usage across all completions.
37    pub usage: agent::completions::response::Usage,
38}
39
40impl VectorCompletion {
41    /// Normalize non-deterministic fields for test snapshot comparison.
42    pub fn normalize_for_tests(&mut self) {
43        self.id = String::new();
44        self.created = 0;
45        for completion in &mut self.completions {
46            completion.inner.normalize_for_tests();
47        }
48        self.votes.sort_by_key(|v| v.flat_swarm_index);
49
50        // sort completions by JSON representation since ordering is non-determinstic
51        self.completions
52            .sort_by_cached_key(|c| serde_json::to_string(&c.inner).unwrap());
53
54        // re-apply completion indices since indices are non-deterministic
55        // (first-come-first-served by design) — and REMAP the votes'
56        // `completion_index` through the same renumbering, or the
57        // votes keep pointing at the arrival-ordered indices and leak
58        // the non-determinism into normalized snapshots.
59        let mut index_map = std::collections::HashMap::new();
60        let mut i = 0;
61        for completion in &mut self.completions {
62            index_map.insert(completion.index, i);
63            completion.index = i;
64            i += 1;
65        }
66        for vote in &mut self.votes {
67            if let Some(completion_index) = vote.completion_index {
68                // A dangling reference (no matching completion) is
69                // left as-is rather than silently rewritten.
70                if let Some(new_index) = index_map.get(&completion_index) {
71                    vote.completion_index = Some(*new_index);
72                }
73            }
74        }
75    }
76
77    /// Creates a default completion with uniform scores for the given number of responses.
78    pub fn default_from_request_responses_len(
79        request_responses_len: usize,
80    ) -> Self {
81        let weights = vec![rust_decimal::Decimal::ZERO; request_responses_len];
82        let scores =
83            vec![
84                rust_decimal::Decimal::ONE
85                    / rust_decimal::Decimal::from(request_responses_len);
86                request_responses_len
87            ];
88        Self {
89            id: String::new(),
90            completions: Vec::new(),
91            votes: Vec::new(),
92            scores,
93            weights,
94            created: 0,
95            swarm: String::new(),
96            object: super::Object::default(),
97            usage: agent::completions::response::Usage::default(),
98        }
99    }
100}
101
102impl From<response::streaming::VectorCompletionChunk> for VectorCompletion {
103    fn from(
104        response::streaming::VectorCompletionChunk {
105            id,
106            completions,
107            votes,
108            scores,
109            weights,
110            created,
111            swarm,
112            object,
113            usage,
114        }: response::streaming::VectorCompletionChunk,
115    ) -> Self {
116        Self {
117            id,
118            completions: completions
119                .into_iter()
120                .map(super::AgentCompletion::from)
121                .collect(),
122            votes,
123            scores,
124            weights,
125            created,
126            swarm,
127            object: object.into(),
128            usage: usage.unwrap_or_default(),
129        }
130    }
131}