Skip to main content
Start a run in Hue, execute your existing agent in your environment, and inspect its saved output, generated files, checks and trace. Hue manages eval-set versions, dispatch and scoring. Your application keeps its model provider, instructions, tools and telemetry. To run the agent from your own machine or CI instead, use hue eval or local evaluations.

1. Wrap your existing function

Install @hue-run/sdk@0.27.0 for Node.js 22 or 24 or hue-run==0.15.0 for Python 3.10+. Configure a Read and write key in the same Hue project as the eval set, then set up tracing. This guide creates a dedicated evaluation endpoint. Its delivery checks record whether evaluation evidence arrived; use safe initialization and bounded lifecycle hooks for ordinary customer requests. A telemetry failure must not rerun the agent’s business work.
Expose a server-side POST route. This example uses your application’s existing agent and Hue client:
Adapt the application function and result mapping to your existing code. The target must honor signal. If your application owns OpenTelemetry directly, supply its tracer and a flush callback that checks both trace and log delivery. Keep shared providers alive between requests.Your server also needs OpenTelemetry context propagation to keep child spans in the same trace across asynchronous work. Reuse the context manager initialized by your framework or NodeSDK.
If your app uses only createHue(), initialize a context manager once during server startup, before handling managed requests. Skip this step when your framework or NodeSDK already provides one.
This configures context propagation; keep using your existing Hue client and the tracer: hue.tracer option above.
The helper defaults to Hue Cloud. An optional configured baseUrl or base_url supports another Hue deployment; never take a callback origin from a request. Use a 120-second host request limit for the default 90-second execution plus 30-second finalization allowance. Hue calls the target synchronously. Work still running at the deadline remains uncertain; Hue does not automatically invoke it again.

2. Register the target

Create a dedicated random server credential in your normal secret manager. Configure it as HUE_MANAGED_TARGET_SECRET in your application. In Hue, save your eval-set version, select Run experiment, then Register target. Enter:
  • A recognizable target name and its public HTTPS endpoint.
  • The same dedicated target credential. Keep your tracing HUE_API_KEY separate.
  • Capabilities your application actually implements, such as input:docx, input:pptx, output:docx and output:pptx.
  • A request timeout that fits your host, up to 120 seconds.
Hue stores the credential encrypted and pins the target revision for each run. Changing an endpoint or credential requires a new target registration. Redirects and unsafe destinations are rejected.

3. Run the eval set

Eval-set rows show a one-line input and the case’s defined Checks. Hover or focus an icon for its name; +N lists additional requirements. Open the case to read its full input and expected output. Scores appear after a run. Choose the target, checks and application configuration in Run experiment. Review the case count and unsupported-case summary before selecting Run. A run keeps its eval-set version and covers all cases, with one execution per supported case and at most two active or unresolved target calls per project. Unsupported cases remain visible and receive no fabricated quality score. Managed runs score built-in deterministic checks and configured document verifiers. Hosted AI judges, custom hosted code and manual evaluators are separate workflows.

Files and scoring

Input files arrive as verified bytes with their original name, type, size, hash and role. Only permitted inputs reach the target; expected answers, grading specifications and evaluator-only files stay in Hue. Return actual generated file bytes. A message saying a document was created is not a file. Each file needs one of the 22 supported content types that match its bytes; another type, such as audio/pcm, records the invocation as an error before any upload. At most one returned file may be primary. The adapter supports up to 16 files, 25 MiB each and 64 MiB total in each direction; your application may have stricter limits. Hue saves the outcome before the target finishes its response, then verifies declared telemetry and saves the evidence for scoring. Document checks read the verified stored output in a pinned, isolated environment. Checks preserves individual pass, fail, warn, skipped and error findings. A quality failure is distinct from an execution, upload or verifier failure.

Inspect and retry

Use Outputs to inspect cases and Charts for the selected scoring run. Charts keep missing values, unsupported cases, execution failures and evaluator errors separate. Hover or focus a chart for counts, or expand its data table for exact values. Choose a baseline run to compare runs of the same eval-set version. Metric comparisons require the same evaluator version on both sides. Higher values are not always better—for example, fewer failed checks is better. Missing evidence stays visible instead of becoming zero or pass. Open a result’s Output, Files, Checks and Trace views. Downloads require current project access. Active runs update automatically while their tab is visible. Unresolved attempts refresh less frequently so a delayed outcome can appear without a reload. Completed runs stop refreshing; reloading never relaunches the agent. A saved outcome can recover from a lost HTTP response. Identical callbacks reuse the saved receipt; conflicting outcomes are rejected. If no outcome was saved, the attempt remains uncertain. Claimed unresolved calls still count against the two-call limit and require operator investigation; Hue does not force-release or replay them. Cancellation stops queued dispatch and preserves completed evidence. It cannot forcibly stop an already running customer function. Rescoring uses saved outputs without running the agent again.