Struct OpenApiToolsetBuilder 

pub struct OpenApiToolsetBuilder { /* private fields */ }

Builder for configuring an OpenApiToolset.

Implementations

impl OpenApiToolsetBuilder

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

Override the base URL from the spec.

Examples found in repository

examples/petstore.rs (line 13)

async fn main() -> anyhow::Result<()> {
    let openai = rig::providers::openai::Client::from_env();

    // Parse once at startup — reuse across requests
    let toolset = OpenApiToolset::builder_from_file("examples/petstore.json")?
        .base_url("https://petstore3.swagger.io/api/v3")
        .build()?;

    println!("Loaded {} tools from Petstore spec\n", toolset.len());

    // Simulate a per-request context (e.g. from a logged-in user session)
    let visible_ctx = HashMap::from([
        ("username".to_string(), "user1".to_string()),
        ("preferred_status".to_string(), "available".to_string()),
    ]);
    let context_preamble = OpenApiToolset::context_preamble(&visible_ctx);

    let preamble = format!(
        "You have access to the Swagger Petstore API. \
         Use the available tools to answer questions about the pet store.\n\n\
         {context_preamble}"
    );

    // Create agent with per-request tools (cheap clone)
    let agent = openai
        .agent("gpt-4o")
        .preamble(&preamble)
        .tools(toolset.tools_with_context(&HashMap::new()))
        .build();

    let prompts = [
        "What pets are currently available in the store? Show me the first 3.",
        "How many dogs are in the store?",
        "Look up my user profile and summarize it.",
    ];

    for prompt in prompts {
        println!(">>> {prompt}");
        let response: String = agent.prompt(prompt).await?;
        println!("{response}\n");
    }

    Ok(())
}

examples/context.rs (line 17)

async fn main() -> anyhow::Result<()> {
    let openai = rig::providers::openai::Client::from_env();

    // ---------------------------------------------------------------
    // 1. Visible context — LLM sees the values and uses them in calls
    // ---------------------------------------------------------------
    println!("=== Visible context ===\n");

    let toolset = OpenApiToolset::builder_from_file("examples/petstore.json")?
        .base_url("https://petstore3.swagger.io/api/v3")
        .build()?;

    println!("Loaded {} tools from Petstore spec\n", toolset.len());

    // The LLM sees these values in its preamble and uses them
    // when calling tools. For example, it will pass `username` to getUserByName.
    let visible_ctx = HashMap::from([
        ("username".to_string(), "user1".to_string()),
        ("preferred_status".to_string(), "available".to_string()),
    ]);
    let context_preamble = OpenApiToolset::context_preamble(&visible_ctx);

    let preamble = format!(
        "You have access to the Swagger Petstore API.\n\n\
         {context_preamble}\n\n\
         When I refer to \"my\" profile or data, use the username from the context above."
    );

    let agent = openai
        .agent("gpt-4o")
        .preamble(&preamble)
        .tools(toolset.tools_with_context(&HashMap::new()))
        .build();

    // The LLM picks up username=user1 from the preamble
    // and calls getUserByName with username "user1".
    println!(">>> Look up my user profile and summarize it.");
    let response: String = agent
        .prompt("Look up my user profile and summarize it.")
        .await?;
    println!("{response}\n");

    // The LLM picks up preferred_status=available from the preamble
    // and calls findPetsByStatus with status "available".
    println!(">>> Find pets matching my preferred status.");
    let response: String = agent
        .prompt("Find pets matching my preferred status.")
        .await?;
    println!("{response}\n");

    // ---------------------------------------------------------------
    // 2. Hidden context — auto-injected, LLM never sees the values
    // ---------------------------------------------------------------
    println!("=== Hidden context ===\n");

    // Hidden context is useful for secrets, user IDs, or any parameter
    // the LLM should NOT decide — it's injected automatically at execution
    // time and removed from the tool schema so the LLM can't see or override it.

    // Static hidden context set at build time (e.g. API key for the upstream service)
    let toolset = OpenApiToolset::builder_from_file("examples/petstore.json")?
        .base_url("https://petstore3.swagger.io/api/v3")
        .hidden_context("api_key", "special-key")
        .build()?;

    // Per-request hidden context (e.g. current user from session).
    // The LLM won't see `username` in the tool schema — it's filled in
    // automatically, so it can't hallucinate a different user.
    let per_request_ctx = HashMap::from([("username".to_string(), "user1".to_string())]);

    let agent = openai
        .agent("gpt-4o")
        .preamble(
            "You have access to the Swagger Petstore API. \
             Use the available tools to answer questions about the pet store.",
        )
        .tools(toolset.tools_with_context(&per_request_ctx))
        .build();

    // The LLM calls getUserByName without providing `username` —
    // it's not in the schema. The library injects username=user1 automatically.
    println!(">>> Get my profile.");
    let response: String = agent.prompt("Get my profile.").await?;
    println!("{response}\n");

    Ok(())
}

pub fn client(self, client: Client) -> Self

Provide a pre-configured reqwest client (e.g. with default auth headers or timeouts).

pub fn hidden_context( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a hidden context parameter that will be auto-injected into tool calls. The LLM will not see this parameter in the tool schema.

Examples found in repository

examples/context.rs (line 70)

async fn main() -> anyhow::Result<()> {
    let openai = rig::providers::openai::Client::from_env();

    // ---------------------------------------------------------------
    // 1. Visible context — LLM sees the values and uses them in calls
    // ---------------------------------------------------------------
    println!("=== Visible context ===\n");

    let toolset = OpenApiToolset::builder_from_file("examples/petstore.json")?
        .base_url("https://petstore3.swagger.io/api/v3")
        .build()?;

    println!("Loaded {} tools from Petstore spec\n", toolset.len());

    // The LLM sees these values in its preamble and uses them
    // when calling tools. For example, it will pass `username` to getUserByName.
    let visible_ctx = HashMap::from([
        ("username".to_string(), "user1".to_string()),
        ("preferred_status".to_string(), "available".to_string()),
    ]);
    let context_preamble = OpenApiToolset::context_preamble(&visible_ctx);

    let preamble = format!(
        "You have access to the Swagger Petstore API.\n\n\
         {context_preamble}\n\n\
         When I refer to \"my\" profile or data, use the username from the context above."
    );

    let agent = openai
        .agent("gpt-4o")
        .preamble(&preamble)
        .tools(toolset.tools_with_context(&HashMap::new()))
        .build();

    // The LLM picks up username=user1 from the preamble
    // and calls getUserByName with username "user1".
    println!(">>> Look up my user profile and summarize it.");
    let response: String = agent
        .prompt("Look up my user profile and summarize it.")
        .await?;
    println!("{response}\n");

    // The LLM picks up preferred_status=available from the preamble
    // and calls findPetsByStatus with status "available".
    println!(">>> Find pets matching my preferred status.");
    let response: String = agent
        .prompt("Find pets matching my preferred status.")
        .await?;
    println!("{response}\n");

    // ---------------------------------------------------------------
    // 2. Hidden context — auto-injected, LLM never sees the values
    // ---------------------------------------------------------------
    println!("=== Hidden context ===\n");

    // Hidden context is useful for secrets, user IDs, or any parameter
    // the LLM should NOT decide — it's injected automatically at execution
    // time and removed from the tool schema so the LLM can't see or override it.

    // Static hidden context set at build time (e.g. API key for the upstream service)
    let toolset = OpenApiToolset::builder_from_file("examples/petstore.json")?
        .base_url("https://petstore3.swagger.io/api/v3")
        .hidden_context("api_key", "special-key")
        .build()?;

    // Per-request hidden context (e.g. current user from session).
    // The LLM won't see `username` in the tool schema — it's filled in
    // automatically, so it can't hallucinate a different user.
    let per_request_ctx = HashMap::from([("username".to_string(), "user1".to_string())]);

    let agent = openai
        .agent("gpt-4o")
        .preamble(
            "You have access to the Swagger Petstore API. \
             Use the available tools to answer questions about the pet store.",
        )
        .tools(toolset.tools_with_context(&per_request_ctx))
        .build();

    // The LLM calls getUserByName without providing `username` —
    // it's not in the schema. The library injects username=user1 automatically.
    println!(">>> Get my profile.");
    let response: String = agent.prompt("Get my profile.").await?;
    println!("{response}\n");

    Ok(())
}

pub fn bearer_token(self, token: &str) -> Self

Convenience: create a client with a bearer token Authorization header.

pub fn build(self) -> Result<OpenApiToolset>

Build the toolset, parsing the spec and creating tools.

Examples found in repository

examples/petstore.rs (line 14)

async fn main() -> anyhow::Result<()> {
    let openai = rig::providers::openai::Client::from_env();

    // Parse once at startup — reuse across requests
    let toolset = OpenApiToolset::builder_from_file("examples/petstore.json")?
        .base_url("https://petstore3.swagger.io/api/v3")
        .build()?;

    println!("Loaded {} tools from Petstore spec\n", toolset.len());

    // Simulate a per-request context (e.g. from a logged-in user session)
    let visible_ctx = HashMap::from([
        ("username".to_string(), "user1".to_string()),
        ("preferred_status".to_string(), "available".to_string()),
    ]);
    let context_preamble = OpenApiToolset::context_preamble(&visible_ctx);

    let preamble = format!(
        "You have access to the Swagger Petstore API. \
         Use the available tools to answer questions about the pet store.\n\n\
         {context_preamble}"
    );

    // Create agent with per-request tools (cheap clone)
    let agent = openai
        .agent("gpt-4o")
        .preamble(&preamble)
        .tools(toolset.tools_with_context(&HashMap::new()))
        .build();

    let prompts = [
        "What pets are currently available in the store? Show me the first 3.",
        "How many dogs are in the store?",
        "Look up my user profile and summarize it.",
    ];

    for prompt in prompts {
        println!(">>> {prompt}");
        let response: String = agent.prompt(prompt).await?;
        println!("{response}\n");
    }

    Ok(())
}

examples/context.rs (line 18)

async fn main() -> anyhow::Result<()> {
    let openai = rig::providers::openai::Client::from_env();

    // ---------------------------------------------------------------
    // 1. Visible context — LLM sees the values and uses them in calls
    // ---------------------------------------------------------------
    println!("=== Visible context ===\n");

    let toolset = OpenApiToolset::builder_from_file("examples/petstore.json")?
        .base_url("https://petstore3.swagger.io/api/v3")
        .build()?;

    println!("Loaded {} tools from Petstore spec\n", toolset.len());

    // The LLM sees these values in its preamble and uses them
    // when calling tools. For example, it will pass `username` to getUserByName.
    let visible_ctx = HashMap::from([
        ("username".to_string(), "user1".to_string()),
        ("preferred_status".to_string(), "available".to_string()),
    ]);
    let context_preamble = OpenApiToolset::context_preamble(&visible_ctx);

    let preamble = format!(
        "You have access to the Swagger Petstore API.\n\n\
         {context_preamble}\n\n\
         When I refer to \"my\" profile or data, use the username from the context above."
    );

    let agent = openai
        .agent("gpt-4o")
        .preamble(&preamble)
        .tools(toolset.tools_with_context(&HashMap::new()))
        .build();

    // The LLM picks up username=user1 from the preamble
    // and calls getUserByName with username "user1".
    println!(">>> Look up my user profile and summarize it.");
    let response: String = agent
        .prompt("Look up my user profile and summarize it.")
        .await?;
    println!("{response}\n");

    // The LLM picks up preferred_status=available from the preamble
    // and calls findPetsByStatus with status "available".
    println!(">>> Find pets matching my preferred status.");
    let response: String = agent
        .prompt("Find pets matching my preferred status.")
        .await?;
    println!("{response}\n");

    // ---------------------------------------------------------------
    // 2. Hidden context — auto-injected, LLM never sees the values
    // ---------------------------------------------------------------
    println!("=== Hidden context ===\n");

    // Hidden context is useful for secrets, user IDs, or any parameter
    // the LLM should NOT decide — it's injected automatically at execution
    // time and removed from the tool schema so the LLM can't see or override it.

    // Static hidden context set at build time (e.g. API key for the upstream service)
    let toolset = OpenApiToolset::builder_from_file("examples/petstore.json")?
        .base_url("https://petstore3.swagger.io/api/v3")
        .hidden_context("api_key", "special-key")
        .build()?;

    // Per-request hidden context (e.g. current user from session).
    // The LLM won't see `username` in the tool schema — it's filled in
    // automatically, so it can't hallucinate a different user.
    let per_request_ctx = HashMap::from([("username".to_string(), "user1".to_string())]);

    let agent = openai
        .agent("gpt-4o")
        .preamble(
            "You have access to the Swagger Petstore API. \
             Use the available tools to answer questions about the pet store.",
        )
        .tools(toolset.tools_with_context(&per_request_ctx))
        .build();

    // The LLM calls getUserByName without providing `username` —
    // it's not in the schema. The library injects username=user1 automatically.
    println!(">>> Get my profile.");
    let response: String = agent.prompt("Get my profile.").await?;
    println!("{response}\n");

    Ok(())
}