objectiveai-sdk 2.0.5

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

use std::borrow::Cow;

use serde::{Deserialize, Serialize};

use crate::error;

/// An error from a single agent completion inside a [`FunctionInventionChunk`](super::FunctionInventionChunk).
///
/// Yielded by [`FunctionInventionChunk::inner_errors`](super::FunctionInventionChunk::inner_errors).
/// Identifies the failing completion by its `index` (matching
/// [`AgentCompletionChunk::index`](super::AgentCompletionChunk::index)) and
/// carries the underlying [`ResponseError`](error::ResponseError) as a `Cow`
/// so iteration is zero-allocation (`Cow::Borrowed`) while deserialization
/// always lands in `Cow::Owned`.
///
/// Wire shape:
/// ```json
/// { "agent_completion_index": 1, "error": { } }
/// ```
///
/// Does NOT include the invention chunk's own top-level `.error` — that
/// field is reachable directly via [`FunctionInventionChunk::error`](super::FunctionInventionChunk::error).
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct InnerError<'a> {
    /// Index of the failing completion (matches `AgentCompletionChunk::index`).
    pub agent_completion_index: u64,
    /// The underlying error from the agent completion.
    pub error: Cow<'a, error::ResponseError>,
}