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.",
        "Get the store inventory and tell me the status counts.",
        "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(())
}

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.

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.",
        "Get the store inventory and tell me the status counts.",
        "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(())
}