volition-core 0.2.0

Core library for the Volition AI agent
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

// volition-agent-core/src/models/chat.rs

//! Structures related to chat messages and API responses for OpenAI-compatible endpoints.

use super::tools::ToolCall;
use serde::{Deserialize, Serialize};

/// Represents a message in the chat history sequence sent to/from the AI.
///
/// This struct is used for all roles (`system`, `user`, `assistant`, `tool`)
/// within the conversation history managed by the [`Agent`](crate::Agent).
/// Optional fields are handled by `serde` during serialization/deserialization.
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
pub struct ChatMessage {
    /// The role of the message sender (e.g., "system", "user", "assistant", "tool").
    pub role: String,
    /// The text content of the message.
    /// Present for `system`, `user`, and final `assistant` messages, and `tool` messages.
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub content: Option<String>,
    /// A list of tool calls requested by the assistant.
    /// Only present for `assistant` messages that request tool execution.
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub tool_calls: Option<Vec<ToolCall>>,
    /// The ID of the tool call this message is responding to.
    /// Only present for `tool` messages.
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub tool_call_id: Option<String>,
}

/// Represents one of the possible responses provided by the AI model.
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Choice {
    /// The index of this choice in the list of choices.
    pub index: u32,
    /// The message generated by the AI for this choice.
    pub message: ChatMessage,
    /// The reason the AI model stopped generating tokens (e.g., "stop", "tool_calls").
    pub finish_reason: String,
}

/// Represents the overall structure of a successful response from the AI chat completion API.
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct ApiResponse {
    /// A unique identifier for the API response.
    pub id: String,
    /// The generated text content.
    pub content: String,
    /// The reason the AI model stopped generating tokens (e.g., "stop", "tool_calls").
    pub finish_reason: String,
    /// Number of tokens used in the prompt.
    pub prompt_tokens: u32,
    /// Number of tokens used in the completion.
    pub completion_tokens: u32,
    /// Total number of tokens used.
    pub total_tokens: u32,
    /// A list of completion choices. Currently, only the first choice is used by the [`Agent`](crate::Agent).
    pub choices: Vec<Choice>,
}