For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • About NVIDIA NeMo Relay
    • Overview
    • Architecture
    • Ecosystem
    • Concepts
    • Release Notes
  • Getting Started
    • Agent Runtime Primer
    • Prerequisites
    • Installation
    • Configuration / Setup
    • Quick Start
  • NVIDIA NeMo Relay CLI
    • About
    • Basic Usage
    • Claude Code
    • Codex
    • Cursor
    • Hermes Agent
  • Supported Integrations
    • About
    • OpenClaw Plugin Guide
    • LangChain Integration Guide
    • LangGraph Integration Guide
    • Deep Agents Integration Guide
  • Instrument Applications
    • About
    • Adding Scopes and Marks
    • Instrument a Tool Call
    • Instrument an LLM Call
    • Add Middleware
    • Code Examples
  • Observability Plugin
    • About
    • Configuration
    • Agent Trajectory Interchange Format (ATIF)
    • Agent Trajectory Observability Format (ATOF)
    • OpenTelemetry
    • OpenInference
  • Adaptive Plugin
    • About
    • Configuration
    • Adaptive Cache Governor (ACG)
    • Adaptive Hints
  • NeMo Guardrails Plugin
    • About
    • Configuration
  • Integrate into Frameworks
    • About
    • Adding Scopes
    • Wrap Tool Calls
    • Wrap LLM Calls
    • Handle Non-Serializable Data
    • Using Codecs
    • Provider Codecs
    • Provider Response Codecs
    • Code Examples
  • Build Plugins
    • About
    • Define a Plugin
    • Validate Plugin Configuration
    • Plugin Configuration Files
    • Register Plugin Behavior
    • Design Plugin Configuration
    • NeMo Guardrails Example Plugin
    • Code Examples
  • Contribute
    • About
    • Development Setup
    • Workflow and Reviews
    • Testing and Documentation
  • Reference
    • APIs
      • Python Library Reference
      • Node.js Library Reference
        • Runtime
        • Typed Helpers
        • Plugin Helpers
        • Adaptive Helpers
        • Observability Helpers
      • Rust Library Reference
    • Performance
  • Resources
    • Support and FAQs
    • Glossary
    • Troubleshooting Guide
    • Community
    • Legal
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogo
On this page
  • Interfaces
  • BackendSpec
  • StateConfig
  • TelemetryConfig
  • AdaptiveHintsConfig
  • ToolParallelismConfig
  • AcgStabilityThresholds
  • AcgConfig
  • Config
  • ComponentSpec interface
  • Functions
  • defaultConfig
  • inMemoryBackend
  • redisBackend
  • telemetryConfig
  • adaptiveHintsConfig
  • toolParallelismConfig
  • acgConfig
  • ComponentSpec function
  • Constants
  • ADAPTIVE_PLUGIN_KIND
  • Re-exports
ReferenceAPIsNode.js Library Reference

Adaptive Helpers

||View as Markdown|
Previous

Plugin Helpers

Next

Observability Helpers

Generated from crates/node/adaptive.d.ts.

Import from nemo-relay-node/adaptive.

Adaptive plugin configuration helpers.

Interfaces

BackendSpec

Adaptive state backend selection.

1export interface BackendSpec {
2 kind: string;
3 config?: Record<string, Json>;
4}

StateConfig

Adaptive state configuration.

1export interface StateConfig {
2 backend: BackendSpec;
3}

TelemetryConfig

Built-in adaptive telemetry settings.

1export interface TelemetryConfig {
2 subscriber_name?: string;
3 learners?: string[];
4}

AdaptiveHintsConfig

Built-in adaptive hints injection settings.

1export interface AdaptiveHintsConfig {
2 priority?: number;
3 break_chain?: boolean;
4 inject_header?: boolean;
5 inject_body_path?: string;
6}

ToolParallelismConfig

Built-in adaptive tool scheduling settings.

1export interface ToolParallelismConfig {
2 priority?: number;
3 mode?: 'observe_only' | 'inject_hints' | 'schedule' | string;
4}

AcgStabilityThresholds

ACG prompt-stability classification thresholds.

1export interface AcgStabilityThresholds {
2 stable_threshold?: number;
3 semi_stable_threshold?: number;
4 min_observations_for_full_confidence?: number;
5}

AcgConfig

Adaptive cache-governor settings.

1export interface AcgConfig {
2 provider?: 'anthropic' | 'openai' | 'passthrough' | string;
3 observation_window?: number;
4 priority?: number;
5 stability_thresholds?: AcgStabilityThresholds;
6}

Config

Canonical config object for the top-level adaptive component.

1export interface Config {
2 version?: number;
3 agent_id?: string;
4 state?: StateConfig;
5 telemetry?: TelemetryConfig;
6 adaptive_hints?: AdaptiveHintsConfig;
7 tool_parallelism?: ToolParallelismConfig;
8 acg?: AcgConfig;
9 policy?: ConfigPolicy;
10}

ComponentSpec interface

Top-level adaptive component wrapper with fixed kind adaptive.

1export interface ComponentSpec {
2 kind: 'adaptive';
3 enabled?: boolean;
4 config: Config;
5}

Functions

defaultConfig

Create a default adaptive component config.

Returns the minimal top-level adaptive config shape with version = 1 so callers can add state, telemetry, and scheduler settings incrementally.

Returns

A new adaptive config object.

Remarks

The returned object is detached from runtime state until it is wrapped with ComponentSpec and activated through the plugin system.

1export declare function defaultConfig(): Config;

inMemoryBackend

Create an in-memory adaptive state backend spec.

Produces the backend descriptor for ephemeral adaptive state stored inside the current process rather than an external datastore.

Returns

An adaptive backend spec using in-memory storage.

Remarks

This backend does not persist state across process restarts.

1export declare function inMemoryBackend(): BackendSpec;

redisBackend

Create a Redis-backed adaptive state backend spec.

Produces the backend descriptor expected by the adaptive plugin when state should be shared or persisted through Redis.

Parameters

  • url: Redis connection URL for the backend.
  • keyPrefix: Prefix applied to Redis keys.

Returns

An adaptive backend spec using Redis storage.

Remarks

The default key prefix namespaces runtime records under nemo_relay: unless a different prefix is supplied.

1export declare function redisBackend(url: string, keyPrefix?: string): BackendSpec;

telemetryConfig

Create adaptive telemetry settings with runtime defaults applied.

Merges caller-supplied overrides onto the built-in telemetry config shape used by the adaptive plugin.

Parameters

  • config: Partial telemetry settings to override.

Returns

A normalized adaptive telemetry config object.

Remarks

An empty learners array is supplied by default so callers can append learner names without checking for initialization first.

1export declare function telemetryConfig(config?: TelemetryConfig): TelemetryConfig;

adaptiveHintsConfig

Create adaptive hint-injection settings with defaults applied.

Merges caller-supplied overrides onto the default config used by the adaptive hints injector.

Parameters

  • config: Partial adaptive hints settings to override.

Returns

A normalized adaptive hints config object.

Remarks

By default the injector runs at priority 100, preserves the rest of the chain, and writes hints to nvext.agent_hints.

1export declare function adaptiveHintsConfig(config?: AdaptiveHintsConfig): AdaptiveHintsConfig;

toolParallelismConfig

Create adaptive tool-parallelism settings with defaults applied.

Merges caller-supplied overrides onto the scheduler config shape used by the adaptive plugin’s tool parallelism component.

Parameters

  • config: Partial tool scheduling settings to override.

Returns

A normalized tool-parallelism config object.

Remarks

The default mode is observe_only, so recommendations are produced without changing execution behavior unless the caller opts in.

1export declare function toolParallelismConfig(config?: ToolParallelismConfig): ToolParallelismConfig;

acgConfig

Create adaptive cache-governor settings with defaults applied.

Merges caller-supplied overrides onto the Adaptive Cache Governor (ACG) config shape used by the adaptive plugin’s LLM execution intercept.

Parameters

  • config: Partial Adaptive Cache Governor (ACG) settings to override.

Returns

A normalized adaptive cache-governor config object.

Remarks

Nested stability_thresholds values are defaulted individually so callers can override only the thresholds they need.

1export declare function acgConfig(config?: AcgConfig): AcgConfig;

ComponentSpec function

Wrap adaptive config as a top-level component.

Produces the plugin component entry that can be inserted directly into plugin.defaultConfig().components.

Parameters

  • config: Adaptive component configuration document.
  • options: Optional component-level flags.

Returns

A plugin component spec for the adaptive plugin.

Remarks

Setting options.enabled = false keeps the config in the plugin document for validation while skipping runtime activation.

1export declare function ComponentSpec(
2 config: Config,
3 options?: {
4 enabled?: boolean;

Constants

ADAPTIVE_PLUGIN_KIND

1export declare const ADAPTIVE_PLUGIN_KIND: 'adaptive';

Re-exports

  • ConfigDiagnostic
  • ConfigPolicy
  • ConfigReport