api_xai 0.3.0

X.AI Grok API client for accessing large language models (LLMs).
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

mod private
{
  use serde::{ Serialize, Deserialize };

  /// Token usage information for API requests.
  ///
  /// Tracks the number of tokens consumed in prompts, completions, and total.
  /// Used for billing and quota management.
  ///
  /// # Examples
  ///
  /// ```
  /// use api_xai::Usage;
  ///
  /// let usage = Usage {
  ///   prompt_tokens : 10,
  ///   completion_tokens : 20,
  ///   total_tokens : 30,
  /// };
  ///
  /// assert_eq!( usage.total_tokens, usage.prompt_tokens + usage.completion_tokens );
  /// ```
  #[ derive( Debug, Serialize, Deserialize, Clone, PartialEq, Eq ) ]
  pub struct Usage
  {
    /// Number of tokens in the prompt (input).
    pub prompt_tokens : u32,

    /// Number of tokens in the completion (output).
    pub completion_tokens : u32,

    /// Total number of tokens (prompt + completion).
    pub total_tokens : u32,
  }

  /// Message role in a conversation.
  ///
  /// XAI API supports flexible message role ordering (unlike `OpenAI` which
  /// requires strict alternation). Messages can be in any order.
  ///
  /// # Roles
  ///
  /// - `System`: System instructions and context
  /// - `User`: User messages and queries
  /// - `Assistant`: AI assistant responses
  /// - `Tool`: Tool execution results (for function calling)
  ///
  /// # Examples
  ///
  /// ```
  /// use api_xai::Role;
  ///
  /// let system_role = Role::System;
  /// let user_role = Role::User;
  /// let assistant_role = Role::Assistant;
  /// ```
  #[ derive( Debug, Serialize, Deserialize, Clone, PartialEq, Eq ) ]
  #[ serde( rename_all = "lowercase" ) ]
  pub enum Role
  {
    /// System message providing instructions or context.
    System,

    /// User message containing queries or prompts.
    User,

    /// Assistant message containing AI responses.
    Assistant,

    /// Tool message containing function execution results.
    Tool,
  }
}

crate::mod_interface!
{
  exposed use
  {
    Usage,
    Role,
  };
}