Skip to main content

GrokLlm

Struct GrokLlm 

Source
pub struct GrokLlm { /* private fields */ }
Expand description

XAI Grok LLM implementation.

Provides access to Grok models through the XAI API. The API is OpenAI-compatible with some differences in token counting.

§Authentication

The API key can be provided explicitly or loaded from the XAI_API_KEY environment variable via from_env.

§Model Selection

Common model names:

  • grok-beta - Grok Beta
  • grok-vision-beta - Grok Vision Beta

§Token Counting Bug

Important: Grok has a known bug where reasoning_tokens in completion_tokens_details is NOT included in the top-level completion_tokens. This implementation automatically corrects this by adding reasoning_tokens to completion_tokens for accurate usage tracking.

§Examples

use radkit::models::providers::GrokLlm;
use radkit::models::{BaseLlm, Thread};

// From environment variable
let llm = GrokLlm::from_env("grok-beta")?;

// With explicit API key
let llm = GrokLlm::new("grok-beta", "xai-...");

// Generate content
let thread = Thread::from_user("Explain quantum computing");
let response = llm.generate_content(thread, None).await?;
println!("{}", response.content().first_text().unwrap_or("No response"));

Implementations§

Source§

impl GrokLlm

Source

pub const API_KEY_ENV: &str = "XAI_API_KEY"

Environment variable name for the XAI API key.

Source

pub fn new(model_name: impl Into<String>, api_key: impl Into<String>) -> Self

Creates a new Grok LLM instance with explicit API key.

§Arguments
  • model_name - The model to use (e.g., “grok-beta”)
  • api_key - XAI API key
§Examples
let llm = GrokLlm::new("grok-beta", "xai-...");
Source

pub fn from_env(model_name: impl Into<String>) -> AgentResult<Self>

Creates a new Grok LLM instance loading API key from environment.

Reads the API key from the XAI_API_KEY environment variable.

§Arguments
  • model_name - The model to use (e.g., “grok-beta”)
§Errors

Returns an error if the environment variable is not set or is empty.

§Examples
let llm = GrokLlm::from_env("grok-beta")?;
Source

pub fn with_base_url(self, base_url: impl Into<String>) -> Self

Sets a custom base URL for the API endpoint.

Source

pub const fn with_max_tokens(self, max_tokens: u32) -> Self

Sets the maximum number of tokens to generate.

Source

pub const fn with_temperature(self, temperature: f32) -> Self

Sets the temperature for generation (0.0 to 2.0).

Higher values produce more random outputs.

Trait Implementations§

Source§

impl BaseLlm for GrokLlm

Source§

fn model_name(&self) -> &str

Returns the model identifier for this LLM instance. Read more
Source§

fn generate_content<'life0, 'async_trait>( &'life0 self, thread: Thread, toolset: Option<Arc<dyn BaseToolset>>, ) -> Pin<Box<dyn Future<Output = AgentResult<LlmResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Generates content in response to a conversation thread. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> BaseLlmExt for T
where T: BaseLlm + ?Sized,

Source§

fn generate<'life0, 'async_trait, T>( &'life0 self, thread: T, toolset: Option<Arc<dyn BaseToolset>>, ) -> Pin<Box<dyn Future<Output = AgentResult<LlmResponse>> + Send + 'async_trait>>
where T: 'async_trait + Into<Thread> + MaybeSend, Self: Sync + 'async_trait, 'life0: 'async_trait,

Generates content from any type convertible to a Thread. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> MaybeSend for T
where T: Send + ?Sized,

Source§

impl<T> MaybeSync for T
where T: Sync + ?Sized,

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more