objectiveai-sdk 2.1.0

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

//! On-disk shape of an `AssistantResponseChunk` log file.
//!
//! Mirrors [`super::AssistantResponseChunk`] field-for-field, with
//! these type swaps:
//!
//! - `content: Option<RichContent>` → `Option<RichContentLog>` so
//!   media parts can be replaced by references.
//! - `logprobs: Option<Logprobs>` → `Option<LogReference>` (logprobs
//!   payload extracted to its own file).
//! - `reasoning: Option<String>` → `Option<LogReference>` (extracted
//!   to its own file under `messages/reasoning/`).
//! - `refusal: Option<String>` → `Option<LogReference>` (extracted to
//!   its own file under `messages/refusal/`).
//! - `tool_calls: Option<Vec<AssistantToolCallDelta>>` →
//!   `Option<Vec<LogReference>>` (each tool call extracted to its
//!   own file under `messages/tool_calls/`, named by message + tool
//!   call index).
//!
//! Field declaration order matches the wire chunk's order so the
//! on-disk JSON keys come out in the same sequence today's
//! `serde_json::to_value(&shell)` produces. Optional fields use
//! `skip_serializing_if = "Option::is_none"` everywhere the wire
//! chunk does, except for `finish_reason` which is always serialized
//! (even when `None` → JSON `null`) — same as the wire chunk.

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

use crate::agent::completions::message;
use crate::agent::completions::response;
use crate::logs::LogReference;

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[schemars(
    rename = "agent.completions.response.streaming.AssistantResponseChunkLog"
)]
pub struct AssistantResponseChunkLog {
    pub role: response::AssistantRole,
    pub index: u64,
    pub created: u64,
    pub model: String,
    pub upstream_id: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schemars(extend("omitempty" = true))]
    pub reasoning: Option<LogReference>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schemars(extend("omitempty" = true))]
    pub tool_calls: Option<Vec<LogReference>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schemars(extend("omitempty" = true))]
    pub content: Option<message::RichContentLog>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schemars(extend("omitempty" = true))]
    pub refusal: Option<LogReference>,
    pub finish_reason: Option<response::FinishReason>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schemars(extend("omitempty" = true))]
    pub logprobs: Option<LogReference>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schemars(extend("omitempty" = true))]
    pub service_tier: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schemars(extend("omitempty" = true))]
    pub system_fingerprint: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schemars(extend("omitempty" = true))]
    pub provider: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schemars(extend("omitempty" = true))]
    pub usage: Option<response::UpstreamUsage>,
}