objectiveai-sdk 2.2.3

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

use crate::agent;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

#[derive(
    Debug,
    Clone,
    PartialEq,
    Serialize,
    Deserialize,
    JsonSchema,
    arbitrary::Arbitrary,
)]
#[schemars(rename = "agent.completions.response.ToolResponse")]
pub struct ToolResponse {
    pub role: ToolRole,
    #[arbitrary(with = crate::arbitrary_util::arbitrary_u64)]
    pub index: u64,
    #[serde(flatten)]
    pub inner: agent::completions::message::ToolMessage,
    /// Mirrors `AssistantResponseChunk.request_message_ids` —
    /// the consumed `message_queue_contents.id`s. Currently never
    /// populated (the API stamps the assistant chunk instead);
    /// the field exists so the wire shape is symmetric across
    /// the two `MessageChunk` variants. Both `None` and
    /// `Some(empty)` are skipped on serialize.
    #[serde(default, skip_serializing_if = "request_message_ids_is_empty")]
    #[schemars(extend("omitempty" = true))]
    #[arbitrary(with = crate::arbitrary_util::arbitrary_option_vec_i64)]
    pub request_message_ids: Option<Vec<i64>>,
}

fn request_message_ids_is_empty(opt: &Option<Vec<i64>>) -> bool {
    opt.as_ref().map_or(true, |v| v.is_empty())
}


#[derive(
    Debug,
    Clone,
    Copy,
    Serialize,
    Deserialize,
    Default,
    PartialEq,
    Eq,
    JsonSchema,
    arbitrary::Arbitrary,
)]
#[schemars(rename = "agent.completions.response.ToolRole")]
pub enum ToolRole {
    #[serde(rename = "tool")]
    #[default]
    Tool,
}