ReferenceAPIsRust Library Referencenemo-relay-adaptive

Struct Adaptive Runtime

View as Markdown

Generated from cargo doc --no-deps -p nemo-relay -p nemo-relay-adaptive -p nemo-relay-ffi.

1pub struct AdaptiveRuntime { /* private fields */ }

Hosted adaptive runtime that registers NeMo Relay plugin components.

This type validates configuration, builds the configured storage backend, registers intercepts and subscribers, and maintains the hot cache used by adaptive features on the request path.

Implementations

impl AdaptiveRuntime

impl AdaptiveRuntime

new

pub async fn new(config: AdaptiveConfig) -> Result<Self>

Create a new adaptive runtime from configuration.

Parameters
  • config: Adaptive runtime configuration to validate and apply.
Returns

A Result containing a new AdaptiveRuntime.

Errors

Returns AdaptiveError::InvalidConfig when validation reports errors, or any backend-construction error produced while building the configured state backend.

validate_config

pub fn validate_config(config: &AdaptiveConfig) -> ConfigReport

Validate an adaptive runtime configuration without constructing a runtime.

Parameters
  • config: Configuration to validate.
Returns

A ConfigReport containing validation diagnostics.

report

pub fn report(&self) -> &ConfigReport

Return the configuration report captured during construction.

Returns

The ConfigReport associated with this runtime.

wait_for_idle

pub fn wait_for_idle(&self)

Block until the telemetry drain has processed all pending events.

Notes

This method performs a simple polling wait and is intended for tests, shutdown paths, or other coordination points.

build_cache_request_facts

pub fn build_cache_request_facts(
    &self,
    agent_id: &str,
    provider: &str,
    annotated_request: &AnnotatedLlmRequest,
) -> Option<CacheRequestFacts>

Build cache-diagnostics facts for an annotated request.

Parameters
  • agent_id: Agent identifier associated with the request.
  • provider: Logical provider name associated with the request.
  • annotated_request: Annotated request to analyze.
Returns

Some(CacheRequestFacts) when enough hot-cache state is available to derive them and None otherwise.

bind_scope

pub fn bind_scope(&mut self, scope_uuid: Uuid) -> Result<()>

Bind the runtime’s ACG request rewrite to an active scope.

External framework integrations can bind the runtime to a session scope and then invoke nemo_relay.llm.request_intercepts(...) explicitly at the provider boundary. Once any scope is bound, this runtime’s hosted ACG execution intercept becomes pass-through so external frameworks do not double-translate requests.

Errors

Returns an error when the runtime is not yet registered, when ACG is not configured for this runtime, or when the scope-local request intercept cannot be constructed or registered.

register

pub async fn register(&mut self) -> Result<()>

Register all configured adaptive features with the shared runtime.

Returns

A Result that is Ok(()) when registration succeeds.

Errors

Returns any error raised while seeding state or registering features.

deregister

pub fn deregister(&mut self) -> Result<()>

Deregister all previously registered adaptive features.

Returns

A Result that is Ok(()) after registrations have been rolled back.

Errors

Returns any rollback error surfaced by the hosted plugin system.

shutdown

pub async fn shutdown(self) -> Result<()>

Deregister the runtime and consume it.

Returns

A Result that is Ok(()) when shutdown completes.

Errors

Propagates any error returned by Self::deregister.

Trait Implementations

impl Debug for AdaptiveRuntime

impl Debug for AdaptiveRuntime

fmt

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

impl Drop for AdaptiveRuntime

impl Drop for AdaptiveRuntime

drop

fn drop(&mut self)