tinychannels 0.1.0

Pluggable channel and messaging primitives for OpenHuman harness communication.
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

//! Harness-facing channel turn and output event types.

use crate::channel::{ChannelInboundEnvelope, MediaReference};
use serde_json::Value;

/// Turn admission verdict.
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize, schemars::JsonSchema,
)]
#[serde(rename_all = "snake_case")]
pub enum TurnAdmissionVerdict {
    Dispatch,
    ObserveOnly,
    Handled,
    Drop,
}

/// Ordered inbound processing lifecycle.
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize, schemars::JsonSchema,
)]
#[serde(rename_all = "snake_case")]
pub enum InboundLifecycleStage {
    Ingest,
    Classify,
    Preflight,
    Resolve,
    Authorize,
    Assemble,
    Record,
    Dispatch,
    Finalize,
}

/// One harness turn assembled from a channel envelope.
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize, schemars::JsonSchema)]
#[serde(default, rename_all = "camelCase")]
pub struct ChannelTurn {
    pub id: String,
    pub session_key: String,
    pub envelope: ChannelInboundEnvelope,
    pub admission: TurnAdmissionVerdict,
    pub lifecycle: Vec<InboundLifecycleStage>,
}

impl Default for ChannelTurn {
    fn default() -> Self {
        Self {
            id: String::new(),
            session_key: String::new(),
            envelope: ChannelInboundEnvelope::default(),
            admission: TurnAdmissionVerdict::Dispatch,
            lifecycle: Vec::new(),
        }
    }
}

/// Harness lifecycle event.
#[derive(
    Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize, schemars::JsonSchema,
)]
#[serde(default, rename_all = "camelCase")]
pub struct HarnessLifecycleEvent {
    pub stage: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
}

/// Output emitted by the harness for channel delivery.
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize, schemars::JsonSchema)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum ChannelOutputEvent {
    TextDelta {
        text: String,
    },
    FinalMessage {
        text: String,
    },
    ToolProgress {
        label: String,
        message: Option<String>,
    },
    ApprovalRequest {
        id: String,
        prompt: String,
        choices: Vec<String>,
    },
    Clarification {
        prompt: String,
    },
    Media {
        text: Option<String>,
        media: Vec<MediaReference>,
    },
    Cancellation {
        reason: Option<String>,
    },
    Lifecycle {
        event: HarnessLifecycleEvent,
    },
    Native {
        data: Value,
    },
}