Skip to main content
Ctrl+K
NVIDIA NeMo Microservices Documentation - Home NVIDIA NeMo Microservices Documentation - Home

NVIDIA NeMo Microservices Documentation

NVIDIA NeMo Microservices Documentation - Home NVIDIA NeMo Microservices Documentation - Home

NVIDIA NeMo Microservices Documentation

Table of Contents

NeMo Microservices (in progress)

  • Getting Started
  • Quickstart Installation
  • Core Concepts
    • Workspaces
  • Studio (old)
  • Core Concepts (old)
    • Platform
    • Studio
    • Entities
    • Customization
    • Evaluation
    • Inference
    • Guardrails
    • Data Designer
    • Safe Synthesizer

Example Applications (in progress)

  • About
  • Create custom evaluations using synthetic data
  • Build an end-to-end data flywheel
  • (TBD) Fine-tune models using synthetic data
  • (TBD) Deploy inference endpoints for agents

Models and Inference

  • About
  • Tutorials
    • Deploy Models
    • Run Inference

Design Synthetic Data (in progress)

  • About
  • Quickstart
  • Tutorials
    • The Basics
    • Seeding
  • Migrating from Standalone Library
  • API Reference

Guardrail Models (in progress)

  • Overview
  • About
    • Guardrails Architecture
    • Guardrail Configurations
    • Running Checks with Guardrails
    • Running Inference with Guardrails
  • Tutorials
    • Integrate with NemoGuard NIM
    • Parallel Rails
    • Multimodal Data
    • Injection Detection
  • Terminology
  • Observability

Evaluate Models (In Progress)

  • About
  • Tutorials
    • Run an Evaluation
    • Run an LLM Judge Eval
  • Metrics
    • LLM-as-a-Judge
    • Agentic
    • RAG
    • RAGAS Live Evaluation
    • Retriever
    • Similarity Metrics
    • Bring Your Own Metric
    • Manage Metrics
    • Manage Jobs
    • Results
  • Benchmarks
    • Custom
    • Agentic
    • Industry
    • Manage Jobs
    • Results

Fine-tune Models (not started)

  • About
  • Tutorials
    • Understanding Configs and Models
    • Format Training Dataset
    • LoRA Customization
    • SFT Customization
    • DPO Customization
    • Distillation Customization
    • Embedding Model Customization
    • Check Job Metrics
    • Optimize Throughput
    • Import Private HF Model
  • Model Catalog
    • Llama Models
    • Llama Nemotron Models
    • Phi Models
    • Embedding Models
    • GPT-OSS Models
    • Gemma Models
    • Dataset Format Requirements
  • Manage Targets
    • Create Target
    • Get Target Details
    • List Targets
    • Update Target
    • Delete Target
    • Target Values
  • Manage Configs
    • List Configs
    • Get Config Details
    • Create Config
    • Update Config
    • Config Reference
    • Training Options
    • Pod Specification
  • Manage Jobs
    • Create Job
    • Get Job Status
    • List Active Jobs
    • Cancel Job
    • Hyperparameter Options

Synthesize Safe Data (Beta)

  • Overview
  • Getting Started
  • About
    • Data Synthesis
    • PII Replacement
    • Evaluation
    • Safe Synthesizer Jobs
    • Parameters Reference
  • Tutorials
    • Safe Synthesizer 101
    • Differential Privacy
    • PII Replacement

Audit Model Safety (Beta) (not started)

  • About
  • Tutorials
    • Run a Simple Job
    • Audit a Local NIM
    • Notebook
  • Manage Targets
    • Basic Target
    • NVIDIA Hosted NIM
    • NIM Proxy
    • Local NIM
    • OpenAI
    • List Targets
    • Update and Delete a Target
    • Target Schema
  • Manage Configs
    • Create Config
    • Get a Config
    • List Configs
    • Update and Delete a Config
    • Probes and Plugins
    • Config Schema
  • Manage Audit Jobs
  • Viewing Audit Job Results
  • Reference

Platform (in progress)

  • About
  • Workspaces
  • Authorization
    • Concepts
    • Managing Access
  • Deploying to Kubernetes
    • Prerequisites
    • Install
    • Database Setup
    • Ingress Setup
    • HuggingFace API Secret
  • Entity Storage
  • Files
  • Data Storage
    • Databases
      • PostgreSQL
      • Milvus
    • PVCs
      • AWS Peristent Volumes
      • Oracle Persistent Volumes
    • Object Storage
      • Amazon S3
    • Backup and Restore
  • Observability
  • Secrets
  • Security

Reference (in progress)

  • Release Notes
  • System Requirements
  • API Reference
    • Platform
    • Auditor
    • Customizer
    • Data Designer
    • Deployment Management
    • Entity Store
    • Evaluator
    • Guardrails
    • Intake
    • Safe Synthesizer
  • SDK Reference
  • CLI Reference
    • Configuration
    • Working with Resources
    • Troubleshooting
    • Full CLI Reference
  • Helm Chart
  • Troubleshooting
    • Troubleshoot Platform Setup
    • Troubleshoot Auditor
    • Troubleshoot Customizer
    • Troubleshoot Data Designer
    • Troubleshoot Evaluator
    • Troubleshoot Guardrails
    • Troubleshoot Studio
  • EULA
  • OSS License Acknowledgements

To-be-deleted: Old and currently unused

  • NVIDIA Distribution in Llama Stack
  • Tenant Configuration Options
  • MLFlow Customizer Secrets (Still needed?)
  • Infrastructure Configurations
    • Core Configs
      • Configure Jobs
    • Entity Store Config
    • Deployment Management Config
    • Operator Config
  • Install Individually
    • Tag-Based Installation
    • NeMo Auditor
      • Helm Chart
    • NeMo Customizer
      • Helm Chart
      • Manage GPUs
        • Configure Cluster GPUs
        • Model Configurations Matrix
        • Troubleshooting GPU Jobs
      • Configure Models
    • NeMo Data Designer
      • Helm Chart
    • NeMo Evaluator
      • Helm Chart
      • Chart Config Options
    • NeMo Guardrails
      • Basic Installation
      • Integrate with NIM Deployed in Cluster
      • Integrate with NIM from build.nvidia.com
      • High Availability
      • Configuration Store
      • Custom Dependencies
      • Observability
      • Deploy on Google Kubernetes Engine
    • NeMo Safe Synthesizer
      • Helm Chart
    • NeMo Studio
      • Helm Chart
  • Overview of NeMo Microservices
  • Key Features
  • Deploy NeMo Auditor with Docker
  • About Getting Started with NeMo Microservices
  • Jupyter Notebooks
  • Install NeMo Microservices Python SDK
  • Demo Cluster Setup
    • Developer Setup Requirements
    • Minikube
      • Set Up Using NeMo Platform Deployment Script
      • Set Up Manually
  • Beginner Platform Tutorials
    • Deploy LLMs
    • Add Safety Checks to LLMs
    • Use Llama Stack APIs
  • Datasets
    • Create Dataset
    • Get Dataset
    • Update Dataset
    • List Datasets
    • Delete Dataset
  • Entity Fields Reference
  • Models
    • Get Details of a Model
    • Update Model
    • List Models
    • Delete Model
  • Namespaces
    • Create Namespace
    • Update Namespace
    • Get Namespace
    • List Namespaces
    • Delete Namespace
  • Projects
    • Create Project
    • Update Project
    • Get Project
    • List Projects
    • Delete Project
  • Entity Management Tutorials
    • Set Up Organizational Entities
    • Create Dataset Files
  • Custom Resource Definitions
  • Feature Details
    • Projects
    • Datasets
    • Models
    • Customizations
    • Evaluations
    • Safe Synthesizer
  • NeMo Studio Feature Overview
  • How NeMo Studio Works
  • Install and Launch NeMo Studio
  • Reference
  • Reference
  • NeMo Microservice API Reference
  • Evaluator API

Evaluator API#

This documentation contains the OpenAPI reference for NVIDIA NeMo Evaluator.

The Evaluator API documentation is available in the Platform API.

previous

Entity Store API

next

Guardrails API
NVIDIA NVIDIA
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2025, NVIDIA Corporation.