GithubModels

AISDK provides first-class support for GithubModels with fully typed model APIs. Model capabilities are enforced at compile time using Rust's type system. This prevents model capability mismatches and guarantees the selected model is valid for the task (e.g. tool calling).

Installation

Enable the GithubModels provider feature:

cargo add aisdk --features github-models

This installs AISDK with the GithubModels provider enabled. Once you have enabled the GithubModels provider, you can use all aisdk features with it.

Create a Provider Instance

To create a provider instance, call GithubModels::model_name(), where model_name is the GithubModels model you want to use. Model names are exposed as snake-case methods.

use aisdk::providers::GithubModels;

let github-models = GithubModels::ai21_labs_ai21_jamba_1_5_large();

This initializes the provider with:

Model: "ai21-labs/ai21-jamba-1.5-large"
API key from environment (if set with GITHUB_TOKEN)
GithubModels's default base URL (https://models.github.ai/inference)

Basic Text Generation

Example using LanguageModelRequest for text generation.

use aisdk::{
    core::LanguageModelRequest,
    providers::GithubModels,
};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {

    let github-models = GithubModels::ai21_labs_ai21_jamba_1_5_large();

    let response = LanguageModelRequest::builder()
        .model(github-models)
        .prompt("Write a short poem about Rust.")
        .build()
        .generate_text()
        .await?;

    println!("Response text: {:?}", response.text());
    Ok(())
}

Provider Settings

You can customize provider configuration using GithubModels::builder()

API Key

let github-models = GithubModels::<Ai21LabsAi21Jamba15Large>::builder()
    .api_key("your-api-key")
    .build()?;

If not specified, AISDK uses the GITHUB_TOKEN environment variable.

Base URL

Useful when routing through a proxy, gateway, or self-hosted compatible endpoint.

let github-models = GithubModels::<Ai21LabsAi21Jamba15Large>::builder()
    .base_url("https://models.github.ai/inference")
    .build()?;

Path (Full URL Override)

Use .path(...) to override the full request URL instead of only the base URL.

let github-models = GithubModels::<Ai21LabsAi21Jamba15Large>::builder()
    .path("https://full-url.example/v1/chat/completions")
    .build()?;

Provider Name

For logging, analytics, and observability.

let github-models = GithubModels::<Ai21LabsAi21Jamba15Large>::builder()
    .provider_name("GithubModels")
    .build()?;

Full Custom Configuration Example

let github-models = GithubModels::<Ai21LabsAi21Jamba15Large>::builder()
    .api_key("your-api-key")
    .base_url("https://models.github.ai/inference")
    .path("https://full-url.example/v1/chat/completions")
    .provider_name("GithubModels")
    .build()?;

Dynamic Model Selection

For runtime model selection (e.g., loading models from config files), use DynamicModel:

Using model_name() Method with Default Settings

use aisdk::providers::GithubModels;

// Specify model as a string at runtime
let github-models = GithubModels::model_name("ai21-labs/ai21-jamba-1.5-large");

Using Builder Pattern with Custom Settings

use aisdk::{
    core::DynamicModel,
    providers::GithubModels,
};

let github-models = GithubModels::<DynamicModel>::builder()
	.model_name("ai21-labs/ai21-jamba-1.5-large")
	.api_key("your-api-key")
	.base_url("https://models.github.ai/inference")
	.path("https://full-url.example/v1/chat/completions")
	.provider_name("GithubModels")
	.build()?;

Warning: When using DynamicModel, model capabilities are not validated at compile time. This means there's no guarantee the model supports requested features (e.g., tool calls, structured output). For compile-time safety, use the typed methods like GithubModels::ai21_labs_ai21_jamba_1_5_large().

Next Steps

Take a deeper look at text generation features Generating Text / Streaming Text
Explore Structured Output for reliable agent data.
Learn how to create Custom Tools.
Learn more about Agents.

GithubModels

On this page