objectiveai-sdk 2.0.6

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

//! Vote type representing a single LLM's selection in a vector completion.

use crate::functions::expression::ToStarlarkValue;
use serde::{Deserialize, Serialize};
use starlark::values::dict::AllocDict as StarlarkAllocDict;
use starlark::values::{Heap as StarlarkHeap, Value as StarlarkValue};
use schemars::JsonSchema;

/// A single LLM's vote in a vector completion.
///
/// Each LLM in the swarm produces a vote indicating which response(s) it
/// selected. Votes are weighted according to the profile and combined to
/// produce the final scores.
///
/// # Vote Format
///
/// The `vote` field is a vector of decimals corresponding to the responses
/// in the request. Typically one element is 1.0 and the rest are 0.0 (discrete
/// selection), but when `top_logprobs` is used, votes may be probability
/// distributions.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, arbitrary::Arbitrary)]
#[schemars(rename = "vector.completions.response.Vote")]
pub struct Vote {
    // --- Identifiers ---

    /// The agent that produced this vote (content-addressed ID).
    pub agent: String,
    /// Index of the agent configuration within the swarm.
    #[arbitrary(with = crate::arbitrary_util::arbitrary_u64)]
    pub swarm_index: u64,
    /// Flattened index accounting for agent counts in the swarm.
    #[arbitrary(with = crate::arbitrary_util::arbitrary_u64)]
    pub flat_swarm_index: u64,
    /// Content hash of the request messages (for caching/deduplication).
    pub prompt_id: String,
    /// Content hashes of each response option in the request.
    pub responses_ids: Vec<String>,

    // --- Vote data ---

    /// The vote distribution. Each index corresponds to a response from the
    /// request. Typically one element is 1.0 (selected) and the rest are 0.0.
    #[serde(deserialize_with = "crate::serde_util::vec_decimal")]
    #[schemars(with = "Vec<f64>")]
    #[arbitrary(with = crate::arbitrary_util::arbitrary_vec_rust_decimal)]
    pub vote: Vec<rust_decimal::Decimal>,

    /// The weight applied to this vote when computing final scores.
    #[serde(deserialize_with = "crate::serde_util::decimal")]
    #[schemars(with = "f64")]
    #[arbitrary(with = crate::arbitrary_util::arbitrary_rust_decimal)]
    pub weight: rust_decimal::Decimal,

    // --- Source flags ---

    /// If true, this vote was reused from a previous request via the `retry`
    /// parameter. All fields reflect the original request's values.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schemars(extend("omitempty" = true))]
    pub retry: Option<bool>,

    /// If true, this vote was retrieved from cache rather than generated fresh.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schemars(extend("omitempty" = true))]
    pub from_cache: Option<bool>,

    // --- Internal ---

    /// Internal index for correlating with completions. Not serialized.
    #[serde(skip)]
    #[arbitrary(with = crate::arbitrary_util::arbitrary_option_u64)]
    pub completion_index: Option<u64>,
}

impl ToStarlarkValue for Vote {
    fn to_starlark_value<'v>(&self, heap: &'v StarlarkHeap) -> StarlarkValue<'v> {
        heap.alloc(StarlarkAllocDict([
            ("agent", self.agent.to_starlark_value(heap)),
            ("swarm_index", self.swarm_index.to_starlark_value(heap)),
            ("flat_swarm_index", self.flat_swarm_index.to_starlark_value(heap)),
            ("prompt_id", self.prompt_id.to_starlark_value(heap)),
            ("responses_ids", self.responses_ids.to_starlark_value(heap)),
            ("vote", self.vote.to_starlark_value(heap)),
            ("weight", self.weight.to_starlark_value(heap)),
            ("retry", self.retry.to_starlark_value(heap)),
            ("from_cache", self.from_cache.to_starlark_value(heap)),
        ]))
    }
}