Struct GrokClient 

pub struct GrokClient { /* private fields */ }

Grok client for generating completions

Implementations

impl GrokClient

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

Create a new Grok client with the provided API key.

Arguments

• api_key - Your xAI API key

Examples

let client = GrokClient::new("your-xai-api-key")?;

pub fn from_env() -> Result<Self>

Create a new Grok client by reading the API key from the XAI_API_KEY environment variable.

Errors

Returns an error if XAI_API_KEY is not set.

Examples

let client = GrokClient::from_env()?;

impl GrokClient

pub fn model<M: Into<Model>>(self, model: M) -> Self

Set the model to use. Accepts either a Model enum variant or a string.

When a string is provided, it will be converted to a Model enum. If the string matches a known model variant, that variant is used; otherwise, it becomes Custom(name). This allows using any model name, including new models or local LLMs, without needing to update the enum.

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

Set the temperature (0.0 to 1.0, lower = more deterministic)

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

Set the maximum tokens to generate

pub fn timeout(self, timeout: Duration) -> Self

Set the timeout for HTTP requests.

This sets the total timeout for each HTTP request made by the client (connection + response). The connect phase additionally keeps the default connect timeout of 30 seconds (DEFAULT_CONNECT_TIMEOUT).

If not called, requests use the default timeout of 5 minutes (DEFAULT_REQUEST_TIMEOUT).

Arguments

• timeout - Timeout duration (e.g., Duration::from_secs(30) for 30 seconds)

pub fn max_retries(self, max_retries: usize) -> Self

Set the maximum number of retry attempts for validation errors.

When materialize encounters a validation error, it will automatically retry up to this many times, including the validation error message in subsequent attempts.

The default is 3 retries. Use .no_retries() to disable retries entirely.

Arguments

• max_retries - Maximum number of retry attempts (0 = no retries, only single attempt)

Examples

let client = OpenAIClient::new("api-key")?
    .max_retries(5);  // Increase to 5 retries (default is 3)

pub fn no_retries(self) -> Self

Disable automatic retries on validation errors.

By default, the client retries up to 3 times when validation errors occur. Use this method to disable retries and fail immediately on the first error.

Examples

let client = OpenAIClient::new("api-key")?
    .no_retries();  // Fail immediately on validation errors

impl GrokClient

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

Set a custom base URL for Grok-compatible APIs (e.g., local LLMs, proxy endpoints).

Arguments

• base_url - Base URL without trailing slash (e.g., “http://localhost:1234/v1” or “https://api.example.com/v1”)

Trait Implementations

impl Clone for GrokClient

fn clone(&self) -> GrokClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<GrokClient> for AnyClient

Available on crate feature grok only.

fn from(client: GrokClient) -> Self

Converts to this type from the input type.

impl LLMClient for GrokClient

fn list_models<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<ModelInfo>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch available models from Grok’s API.

Returns a list of Grok models available for chat completions.

fn from_env() -> Result<Self>

Create a new client by reading the API key from an environment variable.

fn materialize<'life0, 'life1, 'async_trait, T>( &'life0 self, prompt: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<T>> + Send + 'async_trait>>

where T: Instructor + DeserializeOwned + Send + 'static + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Materialize a structured object of type T from a prompt.

fn materialize_with_media<'life0, 'life1, 'life2, 'async_trait, T>( &'life0 self, prompt: &'life1 str, media: &'life2 [MediaFile], ) -> Pin<Box<dyn Future<Output = Result<T>> + Send + 'async_trait>>

where T: Instructor + DeserializeOwned + Send + 'static + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Materialize a structured object with media references (if supported).

fn materialize_with_metadata<'life0, 'life1, 'async_trait, T>( &'life0 self, prompt: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<MaterializeResult<T>>> + Send + 'async_trait>>

where T: Instructor + DeserializeOwned + Send + 'static + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Materialize a structured object with metadata (token usage).

fn generate<'life0, 'life1, 'async_trait>( &'life0 self, prompt: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Raw completion without structure (returns plain text).

fn generate_with_media<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, prompt: &'life1 str, media: &'life2 [MediaFile], ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Raw text completion with media attachments (if supported).

fn generate_with_metadata<'life0, 'life1, 'async_trait>( &'life0 self, prompt: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<GenerateResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Raw completion with metadata (token usage).