Skip to main content

RunAgentClientConfig

Struct RunAgentClientConfig 

Source
pub struct RunAgentClientConfig {
    pub agent_id: String,
    pub entrypoint_tag: String,
    pub local: Option<bool>,
    pub host: Option<String>,
    pub port: Option<u16>,
    pub api_key: Option<String>,
    pub base_url: Option<String>,
    pub extra_params: Option<HashMap<String, Value>>,
    pub enable_registry: Option<bool>,
    pub user_id: Option<String>,
    pub persistent_memory: Option<bool>,
}
Expand description

Configuration for creating a RunAgent client

All fields except agent_id and entrypoint_tag are optional.

§Direct Construction

use runagent::{RunAgentClient, RunAgentClientConfig};

#[tokio::main]
async fn main() -> runagent::RunAgentResult<()> {
    let client = RunAgentClient::new(RunAgentClientConfig {
        agent_id: "agent-id".to_string(),
        entrypoint_tag: "entrypoint".to_string(),
        local: None,
        host: None,
        port: None,
        api_key: Some("key".to_string()),
        base_url: Some("http://localhost:8333/".to_string()),
        extra_params: None,
        enable_registry: None,
        user_id: None,
        persistent_memory: None,
    }).await?;
    Ok(())
}

§Builder Pattern (Alternative)

use runagent::{RunAgentClient, RunAgentClientConfig};
use std::env;

#[tokio::main]
async fn main() -> runagent::RunAgentResult<()> {
    let client = RunAgentClient::new(
        RunAgentClientConfig::new("agent-id", "entrypoint")
            .with_api_key(env::var("RUNAGENT_API_KEY").unwrap_or_else(|_| "key".to_string()))
            .with_base_url("http://localhost:8333/")
    ).await?;
    Ok(())
}

Fields§

§agent_id: String

Agent ID (required)

§entrypoint_tag: String

Entrypoint tag (required)

§local: Option<bool>

Whether this is a local agent (default: false)

§host: Option<String>

Host for local agents (optional, will lookup from DB if not provided and local=true)

§port: Option<u16>

Port for local agents (optional, will lookup from DB if not provided and local=true)

§api_key: Option<String>

API key for remote agents (optional, can also use RUNAGENT_API_KEY env var)

§base_url: Option<String>

Base URL for remote agents (optional, defaults to https://backend.run-agent.ai)

§extra_params: Option<HashMap<String, Value>>

Extra parameters for future use

§enable_registry: Option<bool>

Enable database registry lookup (default: true for local agents)

§user_id: Option<String>

User ID for persistent memory

§persistent_memory: Option<bool>

Enable persistent memory for this user

Implementations§

Source§

impl RunAgentClientConfig

Source

pub fn new( agent_id: impl Into<String>, entrypoint_tag: impl Into<String>, ) -> Self

Create a new config with required fields

Source

pub fn with_local(self, local: bool) -> Self

Set local flag

Source

pub fn with_address(self, host: impl Into<String>, port: u16) -> Self

Set host and port for local agents

Source

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

Set API key

Source

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

Set base URL

Source

pub fn with_extra_params(self, extra_params: HashMap<String, Value>) -> Self

Set extra parameters

Source

pub fn with_enable_registry(self, enable: bool) -> Self

Enable or disable registry lookup

Source

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

Set user ID for persistent memory

Source

pub fn with_persistent_memory(self, persistent: bool) -> Self

Enable or disable persistent memory for this user

Trait Implementations§

Source§

impl Clone for RunAgentClientConfig

Source§

fn clone(&self) -> RunAgentClientConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RunAgentClientConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for RunAgentClientConfig

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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