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

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

  /// Information about a specific model.
  ///
  /// Contains metadata about an available XAI model including its ID,
  /// creation date, and ownership.
  ///
  /// # Examples
  ///
  /// ```
  /// use api_xai::Model;
  ///
  /// // Typically received from API, not constructed manually
  /// ```
  #[ derive( Debug, Serialize, Deserialize, Clone, PartialEq ) ]
  pub struct Model
  {
    /// Unique model identifier (e.g., "grok-2-1212", "grok-4").
    pub id : String,

    /// Object type (always "model").
    pub object : String,

    /// Unix timestamp when the model was created.
    pub created : u64,

    /// Organization that owns the model.
    pub owned_by : String,
  }

  /// Response from listing all available models.
  ///
  /// Contains an array of model objects with their metadata.
  ///
  /// # Examples
  ///
  /// ```no_run
  /// use api_xai::{ Client, XaiEnvironmentImpl, Secret, ClientApiAccessors };
  ///
  /// # async fn example() -> Result< (), Box< dyn std::error::Error > > {
  /// let secret = Secret::load_with_fallbacks( "XAI_API_KEY" )?;
  /// let env = XaiEnvironmentImpl::new( secret )?;
  /// let client = Client::build( env )?;
  ///
  /// let models = client.models().list().await?;
  /// for model in models.data {
  ///   println!( "Model : {}", model.id );
  /// }
  /// # Ok( () )
  /// # }
  /// ```
  #[ derive( Debug, Serialize, Deserialize, Clone, PartialEq ) ]
  pub struct ListModelsResponse
  {
    /// Object type (always "list").
    pub object : String,

    /// Array of available models.
    pub data : Vec< Model >,
  }
}

crate::mod_interface!
{
  exposed use
  {
    Model,
    ListModelsResponse,
  };
}