turnframe-runtime 0.1.1

Deterministic turn orchestration runtime for Turnframe: interpretation, reduction, interactions, commands, events and response composition
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

//! The conversation as a turn loads it: earlier messages, and what cannot be started.

use serde::{Deserialize, Serialize};
use turnframe_core::ids::WorkflowKey;

/// Who wrote a message of the transcript.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum TranscriptRole {
    /// The user.
    User,
    /// The assistant.
    Assistant,
}

/// One earlier message of the conversation.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct RecentMessage {
    /// Who wrote it.
    pub role: TranscriptRole,
    /// What it said.
    pub text: String,
}

impl RecentMessage {
    /// A message the user wrote.
    #[must_use]
    pub fn user(text: impl Into<String>) -> Self {
        Self {
            role: TranscriptRole::User,
            text: text.into(),
        }
    }

    /// A message the assistant wrote.
    #[must_use]
    pub fn assistant(text: impl Into<String>) -> Self {
        Self {
            role: TranscriptRole::Assistant,
            text: text.into(),
        }
    }
}

/// A workflow this turn cannot start, and the reason it declared.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct UnavailableWorkflow {
    /// The workflow.
    pub workflow: WorkflowKey,
    /// Why, resolved to the turn's locale, in the workflow's own words.
    pub reason: String,
}