Full CLI Reference#
Command-line interface for NeMo Platform.
Getting started:
To connect to an existing NMP deployment, use
nmp auth login --base-url <URL>To start a local NMP deployment, use
nmp quickstart configure
Examples:
nmp workspaces list --output-format markdown
nmp workspaces get default -f json
Usage:
$ nmp [GLOBAL OPTIONS] COMMAND [ARGS]...
Global Options:
--context, -c: The name of the context to use. Overrides the current context in the config file.--base-url: Base URL for the NeMo Platform API--output-format, -f <CHOICE>: Output format for how results are printed. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output--timestamp-format <CHOICE>: Timestamp format for table/markdown/csv output [possible values: relative, iso8601]--verbose, -v: Enable verbose messaging. This only impacts logs that are visible, it doesn’t change any data outputs.
Help:
--version, -V: Show version information and exit.--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.
Configuration#
nmp auth#
Manage authentication for NMP.
Usage:
$ nmp auth [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
login: Authenticate with the NMP cluster.logout: Remove stored credentials for the current context.refresh: Refresh the current access token.token: Print the current access token (for use with SDK or curl).status: Show current authentication status.
nmp auth login#
Authenticate with the NMP cluster.
Uses device flow (browser) by default, or password grant when username and password are provided (e.g. for CI).
For quickstart, use --unsigned-token to generate an unsigned JWT.
Examples:
# Set base URL and log in
nmp auth login --base-url https://nmp.example.com
# Context-specific login
nmp auth login --context dev --base-url https://nmp.dev.example.com
# Device flow, open browser
nmp auth login
# Device flow, show code only
nmp auth login --no-browser
Usage:
$ nmp auth login [OPTIONS]
Options:
--context: Context to use for this login command.--base-url: Set cluster base URL for the selected context before login--no-browser: Don’t open browser (device flow only)--scope: OAuth scopes to request (space-separated; quote for multiple, e.g. –scope “platform:read secrets:write”)--username: Username for password grant (CI / non-interactive)--password: Password for password grant (prefer env NMP_OIDC_PASSWORD)
Help:
--help: Show this message and exit.
Unsigned Token Options:
--unsigned-token: Generate and save an unsigned JWT for local/testing authentication.--principal-id: Principal ID for the unsigned token (subclaim). Defaults to –email.--email: Email claim for the unsigned token (required with –unsigned-token).--group: Group claim value for unsigned token (repeat for multiple).--expires-in <INTEGER>: Unsigned token expiry in seconds from now. [default: 3600]--no-exp: Omit the exp claim from the unsigned token.--audience: Audience (aud) claim for unsigned token.--issuer: Issuer (iss) claim for unsigned token.
nmp auth logout#
Remove stored credentials for the current context.
Usage:
$ nmp auth logout [OPTIONS]
Help:
--help: Show this message and exit.
nmp auth refresh#
Refresh the current access token.
This command uses the saved refresh token to obtain a new access token without requiring you to re-authenticate through the browser.
Usage:
$ nmp auth refresh [OPTIONS]
Help:
--help: Show this message and exit.
nmp auth token#
Print the current access token (for use with SDK or curl).
This outputs the raw token to stdout, suitable for piping or capture.
Examples:
# Print token
nmp auth token
# Capture in env var
export TOKEN=$(nmp auth token)
curl -H "Authorization: Bearer $(nmp auth token)" ...
Usage:
$ nmp auth token [OPTIONS]
Help:
--help: Show this message and exit.
nmp auth status#
Show current authentication status.
Usage:
$ nmp auth status [OPTIONS]
Help:
--help: Show this message and exit.
nmp config#
Manage NMP CLI configuration.
Examples:
# Set the cluster base URL (most common first step).
nmp config set --base-url https://nmp.example.com
# View current effective configuration.
nmp config view
# Switch to a named context.
nmp config use-context dev
Usage:
$ nmp config [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
view: Display the configuration file.set: Set configuration values in the active or provided context.current-context: Display the current context name.use-context: Set the current context in the configuration file.
nmp config view#
Display the configuration file.
By default, this shows only the current context and its referenced cluster and user. Use –all-contexts to show the full configuration.
Usage:
$ nmp config view [OPTIONS]
Options:
--all-contexts: Show all contexts, clusters, and users
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for config. [possible values: json, yaml, raw]
nmp config set#
Set configuration values in the active or provided context.
If no config file exists, creates one with a ‘default’ context. At least one option must be provided.
Examples:
nmp config set --base-url https://api.example.com
nmp config set --workspace my-workspace --output-format json
nmp config set --api-key YOUR_API_KEY
nmp config set --api-key - # prompts for API key securely
nmp config set --access-token YOUR_ACCESS_TOKEN
nmp config set --access-token - # prompts for access token securely
Usage:
$ nmp config set [OPTIONS]
Options:
--base-url: NMP API base URL--api-key: API key for authentication--access-token: OAuth access token for authentication--workspace, -w: Default workspace--output-format, -f <CHOICE>: Default output format [possible values: table, json, yaml, markdown, csv, raw, code]--timestamp-format <CHOICE>: Timestamp display format [possible values: relative, iso8601]--truncate, --no-truncate: Truncate long output values--context: Context to modify (default: current context)--activate: Set this context as the current context
Help:
--help: Show this message and exit.
nmp config current-context#
Display the current context name.
For full context details, use: nmp config view
Usage:
$ nmp config current-context [OPTIONS]
Help:
--help: Show this message and exit.
nmp config use-context#
Set the current context in the configuration file.
Usage:
$ nmp config use-context [OPTIONS] CONTEXT_NAME
Arguments:
<CONTEXT_NAME>: Context name to use
Help:
--help: Show this message and exit.
Deployment#
nmp quickstart#
Quickstart commands for managing NMP container.
Usage:
$ nmp quickstart [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
status: Show quickstart cluster status and configuration.configure: Configure quickstart settings interactively.up: Start the quickstart cluster.down: Stop the quickstart cluster.destroy: Stop the cluster and remove all data and configuration…logs: View cluster logs.doctor: Diagnose quickstart configuration and image settings.
nmp quickstart status#
Show quickstart cluster status and configuration.
Usage:
$ nmp quickstart status [OPTIONS]
Help:
--help: Show this message and exit.
nmp quickstart configure#
Configure quickstart settings interactively.
Usage:
$ nmp quickstart configure [OPTIONS]
Options:
--auto: Auto-configure with defaults (requires NGC_API_KEY env var)
Help:
--help: Show this message and exit.
nmp quickstart up#
Start the quickstart cluster.
Usage:
$ nmp quickstart up [OPTIONS]
Options:
--config, -c <PATH>: Path to platform configuration YAML file--image: Container image to use (overrides default image)--skip-preflight: Skip pre-flight checks--no-pull: Don’t pull the container image--timeout, -t <INTEGER>: Maximum time to wait for service to become healthy (seconds) [default: 300]--force, -f: Restart the service if already running--yes, -y: Accept all prompts with their defaults
Help:
--help: Show this message and exit.
nmp quickstart down#
Stop the quickstart cluster.
Usage:
$ nmp quickstart down [OPTIONS]
Help:
--help: Show this message and exit.
nmp quickstart destroy#
Stop the cluster and remove all data and configuration files.
Usage:
$ nmp quickstart destroy [OPTIONS]
Options:
--yes, -y, -f: Skip confirmation prompt
Help:
--help: Show this message and exit.
nmp quickstart logs#
View cluster logs.
Usage:
$ nmp quickstart logs [OPTIONS]
Options:
--follow, -f: Follow log output--tail, -n <INTEGER>: Number of lines to show from the end [default: 100]--all, -a: Show all logs (overrides –tail)
Help:
--help: Show this message and exit.
nmp quickstart doctor#
Diagnose quickstart configuration and image settings.
Usage:
$ nmp quickstart doctor [OPTIONS]
Help:
--help: Show this message and exit.
nmp cluster-info#
Show information about the connected platform cluster.
Usage:
$ nmp cluster-info [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Use cases#
nmp chat#
Start an interactive chat session with a model.
By default, uses model entity routing where the model name should match what’s shown in ‘nmp models list’.
Use –provider for direct provider routing, where the model argument is passed directly to the provider’s API.
Examples:
nmp chat nvidia-llama-3-3-nemotron-super-49b-v1-5
nmp chat nvidia-llama-3-3-nemotron-super-49b-v1-5 "What is machine learning?"
nmp chat nvidia/llama-3.3-nemotron-super-49b-v1.5 --provider nvidia-build
Usage:
$ nmp chat [OPTIONS] MODEL [PROMPT]
Arguments:
<MODEL>: Model entity name (from ‘nmp models list’) or model ID when using –provider<PROMPT>: Initial prompt to send (omit for interactive mode)
Options:
--provider: Provider name for direct provider routing (bypasses model entity routing)--workspace: Workspace name
Help:
--help: Show this message and exit.
Model Options:
--temperature <FLOAT>: Sampling temperature (0.0 to 2.0)--max-tokens <INTEGER>: Maximum tokens to generate--system-message: System message to set context for the conversation
nmp wait#
Wait for resources to reach a desired status
Usage:
$ nmp wait [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
inference: Wait for inference resources
nmp wait inference#
Wait for inference resources
Usage:
$ nmp wait inference [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
deployment: Wait for a deployment to reach a desired status.provider: Wait for the inference gateway to be ready to route to a…
nmp wait inference deployment#
Wait for a deployment to reach a desired status.
Polls the deployment status until it reaches the desired state or times out. For READY status, optionally verifies the gateway can route to the provider. For DELETED status, waits for the resource to be fully garbage collected.
Exit codes: 0: Desired status reached 1: Timeout or error
Examples:
nmp wait inference deployment my-deployment --status READY
nmp wait inference deployment my-deployment --status READY --timeout 600 --no-check-gateway
nmp wait inference deployment my-deployment --status DELETED --timeout 90
Usage:
$ nmp wait inference deployment [OPTIONS] NAME
Arguments:
<NAME>: Name of the deployment to wait for
Options:
--workspace: Workspace name--status, -s <CHOICE>: Desired status to wait for [possible values: READY, DELETED, PENDING, ERROR; default: READY]--timeout, -t <INTEGER>: Maximum time to wait in seconds [default: 1200]--check-gateway, --no-check-gateway: When waiting for READY, also verify gateway can route to the provider--poll-interval <INTEGER>: Seconds between status checks [default: 3]
Help:
--help: Show this message and exit.
nmp wait inference provider#
Wait for the inference gateway to be ready to route to a provider.
Polls the gateway’s ready endpoint until it can route requests to the specified provider. This is useful after creating a deployment to ensure the gateway has refreshed its cache.
Exit codes: 0: Gateway is ready 1: Timeout
Examples:
nmp wait inference provider my-deployment
nmp wait inference provider my-deployment --timeout 120
Usage:
$ nmp wait inference provider [OPTIONS] NAME
Arguments:
<NAME>: Name of the provider to wait for
Options:
--workspace: Workspace name--timeout, -t <INTEGER>: Maximum time to wait in seconds [default: 60]--poll-interval <INTEGER>: Seconds between status checks [default: 1]
Help:
--help: Show this message and exit.
API#
nmp audit#
Manage audit
Usage:
$ nmp audit [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
info: Infoconfigs: Manage configsjobs: Manage jobsplugins: Manage pluginstargets: Manage targets
nmp audit info#
Info
Usage:
$ nmp audit info [OPTIONS]
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp audit configs#
Manage configs
Usage:
$ nmp audit configs [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create a new Audit config.delete: Delete an Audit config.list: List all Audit configs.list-versions: Get all historical versions of a config.get: Get an Audit config by workspace and config name.update: Update an Audit config.
nmp audit configs create#
Create a new Audit config.
Required fields: name, plugins, reporting, run, system
Examples:
nmp audit configs create --input-file config.json
nmp audit configs create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp audit configs create --input-file -
nmp audit configs create --<option> "value"
Usage:
$ nmp audit configs create [OPTIONS]
Options:
--workspace--name: Config name--plugins: Audit plugins data (JSON string)--reporting: Audit reporting data (JSON string)--run: Audit run data (JSON string)--system: Audit system data (JSON string)--description: Config description--project: The name of the project associated with this config
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp audit configs delete#
Delete an Audit config.
Usage:
$ nmp audit configs delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp audit configs list#
List all Audit configs.
When workspace is provided, lists configs in that workspace only. When workspace is None, lists configs across all accessible workspaces.
Usage:
$ nmp audit configs list [OPTIONS]
Options:
--workspace--project: Filter by project name
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp audit configs list-versions#
Get all historical versions of a config.
Usage:
$ nmp audit configs list-versions [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp audit configs get#
Get an Audit config by workspace and config name.
Usage:
$ nmp audit configs get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp audit configs update#
Update an Audit config.
Examples:
nmp audit configs update <name> --input-file config.json
nmp audit configs update <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp audit configs update <name> --input-file -
nmp audit configs update <name> --<option> "value"
Usage:
$ nmp audit configs update [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--description: Config description--plugins: Audit plugins data (JSON string)--project: The name of the project associated with this config--reporting: Audit reporting data (JSON string)--run: Audit run data (JSON string)--system: Audit system data (JSON string)
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp audit jobs#
Manage jobs
Usage:
$ nmp audit jobs [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
cancel: Cancel Jobcreate: Create Jobdelete: Delete Jobget-logs: Get Job Logsget-status: Get Job Statuslist: List Jobspause: Pause Jobresume: Resume Jobget: Get Jobresults: Manage results
nmp audit jobs cancel#
Cancel Job
Usage:
$ nmp audit jobs cancel [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp audit jobs create#
Create Job
Required fields: spec
Examples:
nmp audit jobs create --input-file config.json
nmp audit jobs create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp audit jobs create --input-file -
nmp audit jobs create --<option> "value"
Usage:
$ nmp audit jobs create [OPTIONS]
Options:
--workspace--spec: Configuration for an audit job. (JSON string)--custom-fields: JSON string--description--name--ownership: JSON string--project
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp audit jobs delete#
Delete Job
Usage:
$ nmp audit jobs delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp audit jobs get-logs#
Get Job Logs
Usage:
$ nmp audit jobs get-logs [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--limit <INTEGER>--page-cursor--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp audit jobs get-status#
Get Job Status
Usage:
$ nmp audit jobs get-status [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp audit jobs list#
List Jobs
Usage:
$ nmp audit jobs list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: created_at, -created_at, updated_at, -updated_at]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str} updated_at: {gte: str, lte: str}
Filter jobs on various criteria.
--filter.name--filter.project--filter.status--filter.workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: name: object project: object
Search jobs using substring matching. You can combine multiple search fields and filters. For example:
--search.name training: searches all jobs with ‘training’ in the name.--search.project my-project: searches all jobs with ‘my-project’ in the project field.--search.name training,eval: searches all jobs with ‘training’ OR ‘eval’ in the name.--search.name training --search.project my-project: searches all jobs with ‘training’ in the name AND ‘my-project’ in the project.
nmp audit jobs pause#
Pause Job
Usage:
$ nmp audit jobs pause [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp audit jobs resume#
Resume Job
Usage:
$ nmp audit jobs resume [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp audit jobs get#
Get Job
Usage:
$ nmp audit jobs get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp audit jobs results#
Manage results
Usage:
$ nmp audit jobs results [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
download: Download Job Resultlist: List Job Resultsget: Get Job Result
nmp audit jobs results download#
Download Job Result
Usage:
$ nmp audit jobs results download [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp audit jobs results list#
List Job Results
Usage:
$ nmp audit jobs results list [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp audit jobs results get#
Get Job Result
Usage:
$ nmp audit jobs results get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp audit plugins#
Manage plugins
Usage:
$ nmp audit plugins [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
list: Get supported Garak plugins list, filtered by type.get: Get detailed information about a specific Garak plugin.
nmp audit plugins list#
Get supported Garak plugins list, filtered by type.
See https://reference.garak.ai/ for details
Usage:
$ nmp audit plugins list [OPTIONS]
Options:
--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in descending order, use-in front of the field name. [possible values: type, -type, name, -name]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence.
Filter results on various criteria.
--filter.type
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp audit plugins get#
Get detailed information about a specific Garak plugin.
Usage:
$ nmp audit plugins get [OPTIONS] NAME
Arguments:
<NAME>
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp audit targets#
Manage targets
Usage:
$ nmp audit targets [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create a new Audit target.delete: Delete an Audit target.list: List all Audit targets.list-versions: Get all historical versions of a target.get: Get an Audit target by workspace and target name.update: Update an Audit target.
nmp audit targets create#
Create a new Audit target.
Required fields: model, name, type
Examples:
nmp audit targets create --input-file config.json
nmp audit targets create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp audit targets create --input-file -
nmp audit targets create --<option> "value"
Usage:
$ nmp audit targets create [OPTIONS]
Options:
--workspace--model: Model identifier--name: Target name--type: Target type (e.g., ‘nim’, ‘openai’)--description: Target description--options: Additional target options (JSON string)--project: The name of the project associated with this target
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp audit targets delete#
Delete an Audit target.
Usage:
$ nmp audit targets delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp audit targets list#
List all Audit targets.
When workspace is provided, lists targets in that workspace only. When workspace is None, lists targets across all accessible workspaces.
Usage:
$ nmp audit targets list [OPTIONS]
Options:
--workspace--project: Filter by project name
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp audit targets list-versions#
Get all historical versions of a target.
Usage:
$ nmp audit targets list-versions [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp audit targets get#
Get an Audit target by workspace and target name.
Usage:
$ nmp audit targets get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp audit targets update#
Update an Audit target.
Examples:
nmp audit targets update <name> --input-file config.json
nmp audit targets update <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp audit targets update <name> --input-file -
nmp audit targets update <name> --<option> "value"
Usage:
$ nmp audit targets update [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--description: Target description--model: Model identifier--options: Additional target options (JSON string)--project: The name of the project associated with this target--type: Target type (e.g., ‘nim’, ‘openai’)
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp customization#
Customization operations
Usage:
$ nmp customization [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
jobs: Manage jobs
nmp customization jobs#
Manage jobs
Usage:
$ nmp customization jobs [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
cancel: Cancel Jobcreate: Create Jobdelete: Delete Jobget-logs: Get Job Logsget-status: Get Job Statuslist: List Jobsget: Get Jobresults: Manage results
nmp customization jobs cancel#
Cancel Job
Usage:
$ nmp customization jobs cancel [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp customization jobs create#
Create Job
Required fields: spec
Examples:
nmp customization jobs create --input-file config.json
nmp customization jobs create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp customization jobs create --input-file -
nmp customization jobs create --<option> "value"
Usage:
$ nmp customization jobs create [OPTIONS]
Options:
--workspace--spec: Input schema for creating customization jobs. (JSON string)--custom-fields: JSON string--description--name--ownership: JSON string--project
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp customization jobs delete#
Delete Job
Usage:
$ nmp customization jobs delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp customization jobs get-logs#
Get Job Logs
Usage:
$ nmp customization jobs get-logs [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--limit <INTEGER>--page-cursor--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp customization jobs get-status#
Get Job Status
Usage:
$ nmp customization jobs get-status [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp customization jobs list#
List Jobs
Usage:
$ nmp customization jobs list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: created_at, -created_at, updated_at, -updated_at]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str} updated_at: {gte: str, lte: str}
Filter jobs on various criteria.
--filter.name--filter.project--filter.status--filter.workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: name: object project: object
Search jobs using substring matching. You can combine multiple search fields and filters. For example:
--search.name training: searches all jobs with ‘training’ in the name.--search.project my-project: searches all jobs with ‘my-project’ in the project field.--search.name training,eval: searches all jobs with ‘training’ OR ‘eval’ in the name.--search.name training --search.project my-project: searches all jobs with ‘training’ in the name AND ‘my-project’ in the project.
nmp customization jobs get#
Get Job
Usage:
$ nmp customization jobs get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp customization jobs results#
Manage results
Usage:
$ nmp customization jobs results [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
download: Download Job Resultlist: List Job Resultsget: Get Job Result
nmp customization jobs results download#
Download Job Result
Usage:
$ nmp customization jobs results download [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp customization jobs results list#
List Job Results
Usage:
$ nmp customization jobs results list [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp customization jobs results get#
Get Job Result
Usage:
$ nmp customization jobs results get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp data-designer#
Data Designer operations
Usage:
$ nmp data-designer [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
jobs: Manage jobs
nmp data-designer jobs#
Manage jobs
Usage:
$ nmp data-designer jobs [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
cancel: Cancel Jobcreate: Create Jobdelete: Delete Jobget-logs: Get Job Logsget-status: Get Job Statuslist: List Jobsget: Get Jobresults: Manage results
nmp data-designer jobs cancel#
Cancel Job
Usage:
$ nmp data-designer jobs cancel [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp data-designer jobs create#
Create Job
Required fields: spec
Examples:
nmp data-designer jobs create --input-file config.json
nmp data-designer jobs create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp data-designer jobs create --input-file -
nmp data-designer jobs create --<option> "value"
Usage:
$ nmp data-designer jobs create [OPTIONS]
Options:
--workspace--spec: JSON string--custom-fields: JSON string--description--name--ownership: JSON string--project
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp data-designer jobs delete#
Delete Job
Usage:
$ nmp data-designer jobs delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp data-designer jobs get-logs#
Get Job Logs
Usage:
$ nmp data-designer jobs get-logs [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--limit <INTEGER>--page-cursor--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp data-designer jobs get-status#
Get Job Status
Usage:
$ nmp data-designer jobs get-status [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp data-designer jobs list#
List Jobs
Usage:
$ nmp data-designer jobs list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: created_at, -created_at, updated_at, -updated_at]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str} updated_at: {gte: str, lte: str}
Filter jobs on various criteria.
--filter.name--filter.project--filter.status--filter.workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: name: object project: object
Search jobs using substring matching. You can combine multiple search fields and filters. For example:
--search.name training: searches all jobs with ‘training’ in the name.--search.project my-project: searches all jobs with ‘my-project’ in the project field.--search.name training,eval: searches all jobs with ‘training’ OR ‘eval’ in the name.--search.name training --search.project my-project: searches all jobs with ‘training’ in the name AND ‘my-project’ in the project.
nmp data-designer jobs get#
Get Job
Usage:
$ nmp data-designer jobs get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp data-designer jobs results#
Manage results
Usage:
$ nmp data-designer jobs results [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
download: Download Job Resultdownload-analysis: Download Job Result Analysisdownload-artifacts: Download Job Result Artifactslist: List Job Resultsget: Get Job Result
nmp data-designer jobs results download#
Download Job Result
Usage:
$ nmp data-designer jobs results download [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp data-designer jobs results download-analysis#
Download Job Result Analysis
Usage:
$ nmp data-designer jobs results download-analysis [OPTIONS] JOB
Arguments:
<JOB>
Options:
--workspace--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp data-designer jobs results download-artifacts#
Download Job Result Artifacts
Usage:
$ nmp data-designer jobs results download-artifacts [OPTIONS] JOB
Arguments:
<JOB>
Options:
--workspace--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp data-designer jobs results list#
List Job Results
Usage:
$ nmp data-designer jobs results list [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp data-designer jobs results get#
Get Job Result
Usage:
$ nmp data-designer jobs results get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp entities#
Manage entities
Usage:
$ nmp entities [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create a new entity of the specified type in the given…delete-entity-by-name: Delete an entity by its name.get-entity-by-id: Get a specific entity by its unique identifier.get-entity-by-name: Get a specific entity by its workspace, type, and name.list: List all entities of a specific type in the given workspace.update-entity-by-name: Update an entity by its name.
nmp entities create#
Create a new entity of the specified type in the given workspace.
If name is not provided, it will be auto-generated based on the entity type.
Examples:
POST /apis/entities/v2/workspaces/default/entities/customization_config
`{"name": "my-config", "data": {"target_id": "llama-2-7b", "training_options": {"learning_rate": 0.01}}}`
Required fields: data
Examples:
nmp entities create <entity_type> --input-file config.json
nmp entities create <entity_type> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp entities create <entity_type> --input-file -
nmp entities create <entity_type> --<option> "value"
Usage:
$ nmp entities create [OPTIONS] ENTITY_TYPE
Arguments:
<ENTITY_TYPE>
Options:
--workspace--data: Entity-specific data (schema is opaque to entity store, validated by client SDK) (JSON string)--name: Entity name (optional - auto-generated if not provided). Name must start with a lowercase letter, be 2-63 characters, and contain only lowercase letters, digits, and hyphens (no consecutive hyphens, cannot end with a hyphen).--parent: Parent entity ID for nested entities--project: The name of the project associated with this entity
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp entities delete-entity-by-name#
Delete an entity by its name.
Examples:
DELETE /apis/entities/v2/workspaces/default/entities/customization_config/my-config
Usage:
$ nmp entities delete-entity-by-name [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--entity-type--parent: Parent entity ID for nested entities
Help:
--help: Show this message and exit.
nmp entities get-entity-by-id#
Get a specific entity by its unique identifier.
This endpoint is primarily for debugging and internal use.
Examples:
GET /apis/entities/v2/entities/customization-config-5Q2LoF8z8M9JZxZsHwJKNn
Usage:
$ nmp entities get-entity-by-id [OPTIONS] ID
Arguments:
<ID>
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp entities get-entity-by-name#
Get a specific entity by its workspace, type, and name.
Examples:
GET /apis/entities/v2/workspaces/default/entities/customization_config/my-config
Usage:
$ nmp entities get-entity-by-name [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--entity-type--parent: Parent entity ID for nested entities
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp entities list#
List all entities of a specific type in the given workspace.
Use workspace=”-” to list entities across all workspaces the principal has access to.
Query Parameters:
sort: Sort field
page, page_size: Pagination
search: Advanced search filters (JSON or bracket notation)
Examples:
GET /apis/entities/v2/workspaces/default/entities/customization_config?sort=-created_at
GET /apis/entities/v2/workspaces/-/entities/customization_config # Cross-workspace query
Usage:
$ nmp entities list [OPTIONS] ENTITY_TYPE
Arguments:
<ENTITY_TYPE>
Options:
--workspace--page <INTEGER>: Page number--page-size <INTEGER>: Items per page--search: Advanced search filter as JSON. Example:{"name":{"$like":"value"}}. Operators:$eq,$like,$lt,$lte,$gt,$gte,$in,$nin,$and,$or,$not. Also supports bracket notation: ?search[$like]=value. Relationship traversal: ?search[$exists]=true or ?search=value--sort: Sort field--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp entities update-entity-by-name#
Update an entity by its name.
Optionally change the entity’s name.
Examples:
PUT /apis/entities/v2/workspaces/default/entities/customization_config/my-config
`{"data": {"target_id": "llama-2-7b", "training_options": {"learning_rate": 0.02}}}`
Required fields: entity_type, data
Examples:
nmp entities update-entity-by-name <name> --input-file config.json
nmp entities update-entity-by-name <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp entities update-entity-by-name <name> --input-file -
nmp entities update-entity-by-name <name> --<option> "value"
Usage:
$ nmp entities update-entity-by-name [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--entity-type--data: Updated entity-specific data (JSON string)--parent: Parent entity ID for nested entities--expected-db-version <INTEGER>: Optional database version for optimistic locking. Update only succeeds if current version matches.--new-name: Updated entity name (optional). Name must start with a lowercase letter, be 2-63 characters, and contain only lowercase letters, digits, and hyphens (no consecutive hyphens, cannot end with a hyphen).--project: The name of the project associated with this entity
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation#
Evaluation operations
Usage:
$ nmp evaluation [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
benchmark-job-results: Manage benchmark_job_resultsbenchmark-jobs: Manage benchmark_jobsbenchmarks: Manage benchmarksmetric-job-results: Manage metric_job_resultsmetric-jobs: Manage metric_jobsmetrics: Manage metrics
nmp evaluation benchmark-job-results#
Manage benchmark_job_results
Usage:
$ nmp evaluation benchmark-job-results [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
delete: Delete an evaluation benchmark job result.list: List stored evaluation results for benchmark jobs.get: Get a specific benchmark job result by workspace and job…
nmp evaluation benchmark-job-results delete#
Delete an evaluation benchmark job result.
Usage:
$ nmp evaluation benchmark-job-results delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp evaluation benchmark-job-results list#
List stored evaluation results for benchmark jobs.
Usage:
$ nmp evaluation benchmark-job-results list [OPTIONS]
Options:
--workspace--aggregate-fields: Aggregate score fields to include in the response (comma-separated or repeated). Default: (‘nan_count’, ‘sum’, ‘mean’, ‘min’, ‘max’). Available: (‘nan_count’, ‘sum’, ‘mean’, ‘min’, ‘max’, ‘std_dev’, ‘variance’, ‘score_type’, ‘percentiles’, ‘histogram’, ‘rubric_distribution’, ‘mode_category’).--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: -created_at, created_at, -updated_at, updated_at, -name, name]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str}
Filter benchmark job results on various criteria.
--filter.benchmark--filter.dataset--filter.model
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str}
Search by benchmark, metrics, dataset, model, and other fields. Supports JSON search (e.g. {"name":{"$like":"llama"}}) with operators: $eq, $like, $lt, $lte, $gt, $gte, $in, $nin, $and, $or, $not. Also supports bracket notation where bare values default to $like.
--search.benchmark--search.dataset--search.metrics--search.model--search.name
nmp evaluation benchmark-job-results get#
Get a specific benchmark job result by workspace and job name.
Usage:
$ nmp evaluation benchmark-job-results get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--aggregate-fields: Aggregate score fields to include in the response (comma-separated or repeated). Default: (‘nan_count’, ‘sum’, ‘mean’, ‘min’, ‘max’). Available: (‘nan_count’, ‘sum’, ‘mean’, ‘min’, ‘max’, ‘std_dev’, ‘variance’, ‘score_type’, ‘percentiles’, ‘histogram’, ‘rubric_distribution’, ‘mode_category’).
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation benchmark-jobs#
Manage benchmark_jobs
Usage:
$ nmp evaluation benchmark-jobs [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
cancel: Cancel Jobcreate: Create Jobdelete: Delete Jobget-logs: Get Job Logsget-status: Get Job Statuslist: List Jobsget: Get Jobresults: Manage results
nmp evaluation benchmark-jobs cancel#
Cancel Job
Usage:
$ nmp evaluation benchmark-jobs cancel [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation benchmark-jobs create#
Create Job
Required fields: spec
Examples:
nmp evaluation benchmark-jobs create --input-file config.json
nmp evaluation benchmark-jobs create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp evaluation benchmark-jobs create --input-file -
nmp evaluation benchmark-jobs create --<option> "value"
Usage:
$ nmp evaluation benchmark-jobs create [OPTIONS]
Options:
--workspace--spec: Input for an offline benchmark evaluation job. Evaluates the benchmark’s dataset against all metrics in the benchmark. (JSON string)--custom-fields: JSON string--description--name--ownership: JSON string--project
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation benchmark-jobs delete#
Delete Job
Usage:
$ nmp evaluation benchmark-jobs delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp evaluation benchmark-jobs get-logs#
Get Job Logs
Usage:
$ nmp evaluation benchmark-jobs get-logs [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--limit <INTEGER>--page-cursor--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp evaluation benchmark-jobs get-status#
Get Job Status
Usage:
$ nmp evaluation benchmark-jobs get-status [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation benchmark-jobs list#
List Jobs
Usage:
$ nmp evaluation benchmark-jobs list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: created_at, -created_at, updated_at, -updated_at]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str} updated_at: {gte: str, lte: str}
Filter jobs on various criteria.
--filter.name--filter.project--filter.status--filter.workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: name: object project: object
Search jobs using substring matching. You can combine multiple search fields and filters. For example:
--search.name training: searches all jobs with ‘training’ in the name.--search.project my-project: searches all jobs with ‘my-project’ in the project field.--search.name training,eval: searches all jobs with ‘training’ OR ‘eval’ in the name.--search.name training --search.project my-project: searches all jobs with ‘training’ in the name AND ‘my-project’ in the project.
nmp evaluation benchmark-jobs get#
Get Job
Usage:
$ nmp evaluation benchmark-jobs get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation benchmark-jobs results#
Manage results
Usage:
$ nmp evaluation benchmark-jobs results [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
download: Download Job Resultlist: List Job Resultsget: Get Job Resultaggregate-scores: Manage aggregate_scoresartifacts: Manage artifactsrow-scores: Manage row_scores
nmp evaluation benchmark-jobs results download#
Download Job Result
Usage:
$ nmp evaluation benchmark-jobs results download [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp evaluation benchmark-jobs results list#
List Job Results
Usage:
$ nmp evaluation benchmark-jobs results list [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp evaluation benchmark-jobs results get#
Get Job Result
Usage:
$ nmp evaluation benchmark-jobs results get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation benchmark-jobs results aggregate-scores#
Manage aggregate_scores
Usage:
$ nmp evaluation benchmark-jobs results aggregate-scores [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
download: Download Job Result Aggregate-Scores
nmp evaluation benchmark-jobs results aggregate-scores download
Download Job Result Aggregate-Scores
Usage:
$ nmp evaluation benchmark-jobs results aggregate-scores download [OPTIONS] JOB
Arguments:
<JOB>
Options:
--workspace--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp evaluation benchmark-jobs results artifacts#
Manage artifacts
Usage:
$ nmp evaluation benchmark-jobs results artifacts [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
download: Download Job Result Artifacts
nmp evaluation benchmark-jobs results artifacts download
Download Job Result Artifacts
Usage:
$ nmp evaluation benchmark-jobs results artifacts download [OPTIONS] JOB
Arguments:
<JOB>
Options:
--workspace--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp evaluation benchmark-jobs results row-scores#
Manage row_scores
Usage:
$ nmp evaluation benchmark-jobs results row-scores [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
download: Download Job Result Row-Scores
nmp evaluation benchmark-jobs results row-scores download
Download Job Result Row-Scores
Usage:
$ nmp evaluation benchmark-jobs results row-scores download [OPTIONS] JOB
Arguments:
<JOB>
Options:
--workspace--limit <INTEGER>--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp evaluation benchmarks#
Manage benchmarks
Usage:
$ nmp evaluation benchmarks [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create a new custom evaluation benchmark.delete: Delete a custom evaluation benchmark.list: List all available evaluation benchmarks.get: Get a specific evaluation benchmark by workspace and…
nmp evaluation benchmarks create#
Create a new custom evaluation benchmark.
Benchmarks can be reused across multiple evaluations. The benchmark type determines the evaluation method (currently only LLM-as-a-Judge is supported).
Required fields: dataset, description, metrics, name
Examples:
nmp evaluation benchmarks create --input-file config.json
nmp evaluation benchmarks create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp evaluation benchmarks create --input-file -
nmp evaluation benchmarks create --<option> "value"
Usage:
$ nmp evaluation benchmarks create [OPTIONS]
Options:
--workspace--dataset: Reference to a Fileset in the Files API. A reference is a string with format ‘workspace/fileset-name’ that points to a persisted fileset entity. When used as a dataset source, all files within the fileset will be downloaded to the job container. See Entity references for the general entity reference pattern used across the platform.--description: The description of the benchmark.--metrics: The metrics that comprise this benchmark (format: workspace/metric_name). (can be repeated)--name: The name of the benchmark.--extended-response: Whether to return the extended benchmark.--labels: Labels are key-value pairs that can be used for grouping and filtering. (JSON string)
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation benchmarks delete#
Delete a custom evaluation benchmark.
Predefined benchmarks cannot be deleted.
Usage:
$ nmp evaluation benchmarks delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp evaluation benchmarks list#
List all available evaluation benchmarks.
Usage:
$ nmp evaluation benchmarks list [OPTIONS]
Options:
--workspace--extended-response: Whether to return the extended benchmark.--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: -created_at, created_at, -updated_at, updated_at, -name, name]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str}
Filter benchmarks on various criteria.
--filter.dataset--filter.project
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str} updated_at: {gte: str, lte: str}
Search benchmarks by name, description, and other fields. Supports JSON search (e.g. {"name":{"$like":"llama"}}) with operators: $eq, $like, $lt, $lte, $gt, $gte, $in, $nin, $and, $or, $not. Also supports bracket notation where bare values default to $like.
--search.description--search.name--search.project
nmp evaluation benchmarks get#
Get a specific evaluation benchmark by workspace and benchmark name.
Usage:
$ nmp evaluation benchmarks get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--extended-response: Whether to return the extended benchmark.
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation metric-job-results#
Manage metric_job_results
Usage:
$ nmp evaluation metric-job-results [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
delete: Delete an evaluation metric job result.list: List stored evaluation results for metric jobs.get: Get a specific metric job result by workspace and job name.
nmp evaluation metric-job-results delete#
Delete an evaluation metric job result.
Usage:
$ nmp evaluation metric-job-results delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp evaluation metric-job-results list#
List stored evaluation results for metric jobs.
Usage:
$ nmp evaluation metric-job-results list [OPTIONS]
Options:
--workspace--aggregate-fields: Aggregate score fields to include in the response (comma-separated or repeated). Default: (‘nan_count’, ‘sum’, ‘mean’, ‘min’, ‘max’). Available: (‘nan_count’, ‘sum’, ‘mean’, ‘min’, ‘max’, ‘std_dev’, ‘variance’, ‘score_type’, ‘percentiles’, ‘histogram’, ‘rubric_distribution’, ‘mode_category’).--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: -created_at, created_at, -updated_at, updated_at, -name, name]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str}
Filter metric job results on various criteria.
--filter.dataset--filter.metric--filter.model
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str}
Search by metric, dataset, model, and other fields. Supports JSON search (e.g. {"name":{"$like":"llama"}}) with operators: $eq, $like, $lt, $lte, $gt, $gte, $in, $nin, $and, $or, $not. Also supports bracket notation where bare values default to $like.
--search.dataset--search.metric--search.model--search.name
nmp evaluation metric-job-results get#
Get a specific metric job result by workspace and job name.
Usage:
$ nmp evaluation metric-job-results get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--aggregate-fields: Aggregate score fields to include in the response (comma-separated or repeated). Default: (‘nan_count’, ‘sum’, ‘mean’, ‘min’, ‘max’). Available: (‘nan_count’, ‘sum’, ‘mean’, ‘min’, ‘max’, ‘std_dev’, ‘variance’, ‘score_type’, ‘percentiles’, ‘histogram’, ‘rubric_distribution’, ‘mode_category’).
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation metric-jobs#
Manage metric_jobs
Usage:
$ nmp evaluation metric-jobs [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
cancel: Cancel Jobcreate: Create Jobdelete: Delete Jobget-logs: Get Job Logsget-status: Get Job Statuslist: List Jobsget: Get Jobresults: Manage results
nmp evaluation metric-jobs cancel#
Cancel Job
Usage:
$ nmp evaluation metric-jobs cancel [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation metric-jobs create#
Create Job
Required fields: spec
Examples:
nmp evaluation metric-jobs create --input-file config.json
nmp evaluation metric-jobs create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp evaluation metric-jobs create --input-file -
nmp evaluation metric-jobs create --<option> "value"
Usage:
$ nmp evaluation metric-jobs create [OPTIONS]
Options:
--workspace--spec: An offline metric job. (JSON string)--custom-fields: JSON string--description--name--ownership: JSON string--project
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation metric-jobs delete#
Delete Job
Usage:
$ nmp evaluation metric-jobs delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp evaluation metric-jobs get-logs#
Get Job Logs
Usage:
$ nmp evaluation metric-jobs get-logs [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--limit <INTEGER>--page-cursor--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp evaluation metric-jobs get-status#
Get Job Status
Usage:
$ nmp evaluation metric-jobs get-status [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation metric-jobs list#
List Jobs
Usage:
$ nmp evaluation metric-jobs list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: created_at, -created_at, updated_at, -updated_at]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str} updated_at: {gte: str, lte: str}
Filter jobs on various criteria.
--filter.name--filter.project--filter.status--filter.workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: name: object project: object
Search jobs using substring matching. You can combine multiple search fields and filters. For example:
--search.name training: searches all jobs with ‘training’ in the name.--search.project my-project: searches all jobs with ‘my-project’ in the project field.--search.name training,eval: searches all jobs with ‘training’ OR ‘eval’ in the name.--search.name training --search.project my-project: searches all jobs with ‘training’ in the name AND ‘my-project’ in the project.
nmp evaluation metric-jobs get#
Get Job
Usage:
$ nmp evaluation metric-jobs get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation metric-jobs results#
Manage results
Usage:
$ nmp evaluation metric-jobs results [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
download: Download Job Resultlist: List Job Resultsget: Get Job Resultaggregate-scores: Manage aggregate_scoresartifacts: Manage artifactsrow-scores: Manage row_scores
nmp evaluation metric-jobs results download#
Download Job Result
Usage:
$ nmp evaluation metric-jobs results download [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp evaluation metric-jobs results list#
List Job Results
Usage:
$ nmp evaluation metric-jobs results list [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp evaluation metric-jobs results get#
Get Job Result
Usage:
$ nmp evaluation metric-jobs results get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation metric-jobs results aggregate-scores#
Manage aggregate_scores
Usage:
$ nmp evaluation metric-jobs results aggregate-scores [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
download: Download Job Result Aggregate-Scores
nmp evaluation metric-jobs results aggregate-scores download
Download Job Result Aggregate-Scores
Usage:
$ nmp evaluation metric-jobs results aggregate-scores download [OPTIONS] JOB
Arguments:
<JOB>
Options:
--workspace--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp evaluation metric-jobs results artifacts#
Manage artifacts
Usage:
$ nmp evaluation metric-jobs results artifacts [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
download: Download Job Result Artifacts
nmp evaluation metric-jobs results artifacts download
Download Job Result Artifacts
Usage:
$ nmp evaluation metric-jobs results artifacts download [OPTIONS] JOB
Arguments:
<JOB>
Options:
--workspace--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp evaluation metric-jobs results row-scores#
Manage row_scores
Usage:
$ nmp evaluation metric-jobs results row-scores [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
download: Download Job Result Row-Scores
nmp evaluation metric-jobs results row-scores download
Download Job Result Row-Scores
Usage:
$ nmp evaluation metric-jobs results row-scores download [OPTIONS] JOB
Arguments:
<JOB>
Options:
--workspace--limit <INTEGER>--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp evaluation metrics#
Manage metrics
Usage:
$ nmp evaluation metrics [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create metrics.delete: Delete a custom evaluation metric.evaluate: Run a synchronous metric evaluation on a dataset.list: List evaluation metrics.get: Get a specific evaluation metric by workspace and metric…
nmp evaluation metrics create#
Create metrics.
Examples:
nmp evaluation metrics create <name> --input-file config.json
nmp evaluation metrics create <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp evaluation metrics create <name> --input-file -
nmp evaluation metrics create <name> --<option> "value"
Usage:
$ nmp evaluation metrics create [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--model: JSON string--scores: JSON string--description--ignore-inference-failure--inference: JSON string--labels: JSON string--prompt-template: JSON string--reasoning: JSON string--structured-output: JSON string--supported-job-types: JSON string--system-prompt--type <CHOICE>: [possible values: llm-judge, topic_adherence, agent_goal_accuracy, answer_accuracy, context_relevance, response_groundedness, context_recall, context_precision, context_entity_recall, response_relevancy, faithfulness, noise_sensitivity, tool_call_accuracy, bleu, exact-match, f1, number-check, remote, nemo-agent-toolkit-remote, rouge, string-check, tool-calling]--judge-model: JSON string--input-template: JSON string--metric-mode <CHOICE>: [possible values: f1, precision, recall]--use-reference--embeddings-model: JSON string--strictness <INTEGER>--references: Can be repeated for multiple values--candidate--reference--left-template--operation <CHOICE>: [possible values: equals, ==, !=, <>, not equals, >=, gte, greater than or equal, >, gt, greater than, <=, lte, less than or equal, <, lt, less than, absolute difference, contains, not contains, startswith, endswith]--right-template--epsilon <FLOAT>--body: JSON string--url--api-key-secret--max-retries <INTEGER>--timeout-seconds <FLOAT>--evaluator-name
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation metrics delete#
Delete a custom evaluation metric.
Predefined metrics cannot be deleted.
Usage:
$ nmp evaluation metrics delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp evaluation metrics evaluate#
Run a synchronous metric evaluation on a dataset.
This endpoint evaluates the given dataset using the specified metric and returns results immediately. Use this for quick, interactive evaluations with small datasets (up to 10 rows). For larger evaluations, use the async job-based evaluation endpoints.
The metric can be specified either as a URN reference to a stored metric (e.g., “workspace/metric_name”) or as an inline metric definition.
The dataset must be provided inline with rows.
Aggregate Score Fields: The name and count fields are always included in
aggregate scores. By default, additional fields returned are: nan_count, sum,
mean, min, max. Use the aggregate_fields query parameter to customize which
optional fields are included (e.g., std_dev, variance, percentiles, histogram,
rubric_distribution, mode_category).
Usage:
$ nmp evaluation metrics evaluate [OPTIONS]
Options:
--workspace--aggregate-fields: Aggregate score fields to include in the response (comma-separated or repeated). Default: (‘nan_count’, ‘sum’, ‘mean’, ‘min’, ‘max’). Available: (‘nan_count’, ‘sum’, ‘mean’, ‘min’, ‘max’, ‘std_dev’, ‘variance’, ‘score_type’, ‘percentiles’, ‘histogram’, ‘rubric_distribution’, ‘mode_category’).
Dataset Options:
--dataset DATASET_JSON: Use –dataset with JSON for complex/nested queries, or –dataset. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: rows: [dict[str, object], …]
Inline dataset for evaluation with a maximum of 10 rows.
Help:
--help: Show this message and exit.
Metric Options:
--metric METRIC_JSON: Use –metric with JSON for complex/nested queries, or –metric. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: scores: [{name: str, rubric: , description: str, parser: JsonScoreParserParam}, …] inference: {max_completion_tokens: int, max_tokens: int, model: str, stop: , temperature: float, top_p: float} labels: dict[str, str] reasoning: {effort: str, end_token: str, include_if_not_finished: bool} structured_output: dict[str, object] supported_job_types: object
The metric to use for evaluation. Can be a reference (workspace/metric_name) or an inline metric definition.
--metric.model--metric.description--metric.ignore-inference-failure--metric.prompt-template--metric.system-prompt--metric.type
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp evaluation metrics list#
List evaluation metrics.
Usage:
$ nmp evaluation metrics list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: -created_at, created_at, -updated_at, updated_at, -name, name]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str}
Filter metrics on various criteria.
--filter.project--filter.type
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str} updated_at: {gte: str, lte: str}
Search metrics by name, description, and other fields. Supports JSON search (e.g. {"name":{"$like":"llama"}}) with operators: $eq, $like, $lt, $lte, $gt, $gte, $in, $nin, $and, $or, $not. Also supports bracket notation where bare values default to $like.
--search.description--search.name--search.project--search.type
nmp evaluation metrics get#
Get a specific evaluation metric by workspace and metric name.
Usage:
$ nmp evaluation metrics get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp files#
Manage files
Usage:
$ nmp files [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
upload: Upload local files to a fileset.download: Download files from a fileset to a local path.list: List files in a fileset.delete: Delete a file from a fileset.filesets: Manage filesetsotlp: Otlp operations
nmp files upload#
Upload local files to a fileset.
Supports uploading single files or directories. For directories, contents are uploaded recursively.
Examples:
# Upload a file to the root of a fileset
nmp files upload ./data.csv --fileset my-fileset
# Upload a directory to a subdirectory in the fileset nmp files upload ./data/ –fileset my-fileset –remote-path uploads/
# Upload without specifying a fileset (auto-creates one) nmp files upload ./data.csv
Usage:
$ nmp files upload [OPTIONS] LOCAL_PATH
Arguments:
<LOCAL_PATH>: Local path to upload
Options:
--workspace--fileset: Name of the fileset to upload to. If not provided, a new fileset is created.--remote-path: Path within the fileset. Defaults to root. [default: ]
Help:
--help: Show this message and exit.
nmp files download#
Download files from a fileset to a local path.
Supports downloading single files or directories. For directories, contents are downloaded recursively.
Examples:
# Download entire fileset to current directory
nmp files download --fileset my-fileset -o ./
# Download a subdirectory from the fileset nmp files download –fileset my-fileset –remote-path data/ -o ./downloads/
Usage:
$ nmp files download [OPTIONS]
Options:
--workspace--fileset: Name of the fileset to download from--remote-path: Path within the fileset. Defaults to root. [default: ]--output, -o <PATH>: Local path to download to.
Help:
--help: Show this message and exit.
nmp files list#
List files in a fileset.
Lists all files recursively from the specified path within the fileset.
Examples:
# List all files in a fileset
nmp files list --fileset my-fileset
# List files in a subdirectory nmp files list –fileset my-fileset –remote-path data/
Usage:
$ nmp files list [OPTIONS]
Options:
--workspace--fileset: Name of the fileset to list files from--remote-path: Path within the fileset. Defaults to root. [default: ]
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.--no-truncate: Don’t truncate long values in table/markdown/csv output.
nmp files delete#
Delete a file from a fileset.
Examples:
# Delete a specific file
nmp files delete --fileset my-fileset --remote-path data/old-file.txt
Usage:
$ nmp files delete [OPTIONS]
Options:
--workspace--fileset: Name of the fileset containing the file--remote-path: Path of the file to delete within the fileset
Help:
--help: Show this message and exit.
nmp files filesets#
Manage filesets
Usage:
$ nmp files filesets [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create a new fileset.delete: Delete Fileset.list: List Filesets endpoint with filtering, search, and…get: Get Fileset by Workspace and Name.update: Update Fileset Metadata.
nmp files filesets create#
Create a new fileset.
If no storage configuration is provided, the default storage backend will be used.
Required fields: name
Examples:
nmp files filesets create --input-file config.json
nmp files filesets create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp files filesets create --input-file -
nmp files filesets create --<option> "value"
Usage:
$ nmp files filesets create [OPTIONS]
Options:
--workspace--name: The name of the fileset. Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.--cache: Cache all files after creation. Only applies to external storage.--custom-fields: Custom fields for the fileset. (JSON string)--description: The description of the fileset.--metadata: Tagged metadata container - the key indicates the type.
Example: metadata = FilesetMetadata( dataset=DatasetMetadataContent( schema={"columns": ["id", "name"]}, ) ) (JSON string)
--project: The name of the project associated with this fileset.--purpose <CHOICE>: The purpose of the fileset. [possible values: dataset, generic, model]--storage: The storage configuration for the fileset. If not provided, uses default storage. (JSON string)
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp files filesets delete#
Delete Fileset.
Permanently deletes a fileset from the platform.
Returns metadata about the deleted fileset. For local storage backends, this also deletes the underlying files.
Usage:
$ nmp files filesets delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp files filesets list#
List Filesets endpoint with filtering, search, and pagination.
Supports filtering by workspace, purpose, storage_type, created_at, and updated_at via query parameters. Supports substring search on name and description via search query parameters. Returns paginated results with sorting options.
Usage:
$ nmp files filesets list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: created_at, -created_at, name, -name]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str} updated_at: {gte: str, lte: str}
Filter filesets on various criteria.
Examples:
--filter.purpose dataset: Filter by purpose--filter.storage-type local: Filter by storage backend type--filter '{“created_at”:{“$gte”:”2025-01-01T00:00:00Z”}}': Filter by creation date (on or after)--filter '{“created_at”:{“$lte”:”2025-12-31T23:59:59Z”}}': Filter by creation date (on or before)--filter '{“updated_at”:{“$gte”:”2025-01-01T00:00:00Z”}}': Filter by update date (on or after)
--filter.name--filter.purpose--filter.storage-type
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence.
Search filesets using substring matching.
Examples:
--search.name training: Search for filesets with “training” in the name--search.description llama: Search for filesets with “llama” in the description
--search.description--search.name
nmp files filesets get#
Get Fileset by Workspace and Name.
Returns the details of a specific fileset identified by its workspace and name.
Usage:
$ nmp files filesets get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp files filesets update#
Update Fileset Metadata.
Examples:
nmp files filesets update <name> --input-file config.json
nmp files filesets update <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp files filesets update <name> --input-file -
nmp files filesets update <name> --<option> "value"
Usage:
$ nmp files filesets update [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--custom-fields: Custom fields for the fileset. (JSON string)--description: The description of the fileset.--metadata: Tagged metadata container - the key indicates the type.
Example: metadata = FilesetMetadata( dataset=DatasetMetadataContent( schema={"columns": ["id", "name"]}, ) ) (JSON string)
--project: The name of the project associated with this fileset.--purpose <CHOICE>: The purpose of the fileset. [possible values: dataset, generic, model]
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp files otlp#
Otlp operations
Usage:
$ nmp files otlp [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
logs: Manage logs
nmp files otlp logs#
Manage logs
Usage:
$ nmp files otlp logs [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Upload OTLP logs to a specified fileset in JSON or…query: Query logs from parquet files in a fileset.
nmp files otlp logs create#
Upload OTLP logs to a specified fileset in JSON or Protobuf format.
Supports both application/json and application/x-protobuf content types.
Examples:
nmp files otlp logs create <name> --input-file config.json
nmp files otlp logs create <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp files otlp logs create <name> --input-file -
nmp files otlp logs create <name> --<option> "value"
Usage:
$ nmp files otlp logs create [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp files otlp logs query#
Query logs from parquet files in a fileset.
This is an internal endpoint that runs DuckDB queries with direct storage access.
Usage:
$ nmp files otlp logs query [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--filters: Key-value filters to apply to the query--limit <INTEGER>: Maximum number of results to return--page-cursor: Cursor for pagination
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp guardrail#
Manage guardrail
Usage:
$ nmp guardrail [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
check: Chat completion for the provided conversation.chat: Chat operationscompletions: Manage completionsconfigs: Manage configs
nmp guardrail check#
Chat completion for the provided conversation.
Required fields: messages, model
Examples:
nmp guardrail check --input-file config.json
nmp guardrail check --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp guardrail check --input-file -
nmp guardrail check --<option> "value"
Usage:
$ nmp guardrail check [OPTIONS]
Options:
--workspace--messages: A list of messages comprising the conversation so far (JSON string)--model: The model to use for completion. Must be one of the available models.--frequency-penalty <FLOAT>: Positive values penalize new tokens based on their existing frequency in the text.--function-call: Deprecated in favor of tool_choice. ‘none’ means the model will not call a function and instead generates a message. ‘auto’ means the model can pick between generating a message or calling a function. Specifying a particular function via {‘name’: ‘my_function’} forces the model to call that function. (JSON string)--guardrails: Guardrails specific options for the request. (JSON string)--ignore-eos: Ignore the eos when running--logit-bias: Modify the likelihood of specified tokens appearing in the completion. Maps token IDs (as strings) to bias values from -100 to 100. (JSON string)--logprobs: Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message--max-completion-tokens <INTEGER>: An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens. Preferred over max_tokens for reasoning models.--max-tokens <INTEGER>: The maximum number of tokens that can be generated in the chat completion.--n <INTEGER>: How many chat completion choices to generate for each input message.--presence-penalty <FLOAT>: Positive values penalize new tokens based on whether they appear in the text so far.--reasoning-effort: Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.--response-format: Format of the response. Use {‘type’: ‘json_object’} for JSON mode or {‘type’: ‘json_schema’, ‘json_schema’: {…}} for structured outputs. (JSON string)--seed <INTEGER>: If specified, attempts to sample deterministically.--stop: Up to 4 sequences where the API will stop generating further tokens. (JSON string)--stream: If set, partial message deltas will be sent, like in ChatGPT.--stream-options: Options for streaming response. Only set this when stream=True. Supports include_usage to receive token usage in the final stream chunk. (JSON string)--temperature <FLOAT>: What sampling temperature to use, between 0 and 2.--tool-choice: Controls which (if any) tool is called by the model. ‘none’ means no tool is called, ‘auto’ lets the model decide, ‘required’ forces a tool call. (JSON string)--tools: A list of tools the model may call. Each tool is an object with a ‘type’ field and a ‘function’ definition. (JSON string)--top-logprobs <INTEGER>: The number of most likely tokens to return at each token position.--top-p <FLOAT>: An alternative to sampling with temperature, called nucleus sampling.--user: A unique identifier representing your end-user, used by some providers for abuse monitoring.--vision: Whether this is a vision-capable request with image inputs.
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp guardrail chat#
Chat operations
Usage:
$ nmp guardrail chat [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
completions: Manage completions
nmp guardrail chat completions#
Manage completions
Usage:
$ nmp guardrail chat completions [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create completions.
nmp guardrail chat completions create#
Create completions.
Required fields: messages, model
Examples:
nmp guardrail chat completions create --input-file config.json
nmp guardrail chat completions create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp guardrail chat completions create --input-file -
nmp guardrail chat completions create --<option> "value"
Usage:
$ nmp guardrail chat completions create [OPTIONS]
Options:
--workspace--messages: JSON string--model--frequency-penalty <FLOAT>--function-call: JSON string--guardrails: JSON string--ignore-eos--logit-bias: JSON string--logprobs--max-completion-tokens <INTEGER>--max-tokens <INTEGER>--n <INTEGER>--presence-penalty <FLOAT>--reasoning-effort--response-format: JSON string--seed <INTEGER>--stop: JSON string--stream--stream-options: JSON string--temperature <FLOAT>--tool-choice: JSON string--tools: JSON string--top-logprobs <INTEGER>--top-p <FLOAT>--user--vision
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp guardrail completions#
Manage completions
Usage:
$ nmp guardrail completions [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create completions.
nmp guardrail completions create#
Create completions.
Required fields: model, prompt
Examples:
nmp guardrail completions create --input-file config.json
nmp guardrail completions create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp guardrail completions create --input-file -
nmp guardrail completions create --<option> "value"
Usage:
$ nmp guardrail completions create [OPTIONS]
Options:
--workspace--model--prompt: JSON string--best-of <INTEGER>--echo--frequency-penalty <FLOAT>--function-call: JSON string--guardrails: JSON string--ignore-eos--logit-bias: JSON string--logprobs--max-completion-tokens <INTEGER>--max-tokens <INTEGER>--n <INTEGER>--presence-penalty <FLOAT>--reasoning-effort--response-format: JSON string--seed <INTEGER>--stop: JSON string--stream--stream-options: JSON string--suffix--temperature <FLOAT>--tool-choice: JSON string--tools: JSON string--top-logprobs <INTEGER>--top-p <FLOAT>--user
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp guardrail configs#
Manage configs
Usage:
$ nmp guardrail configs [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create a new guardrail config.delete: Delete a guardrail config.list: List available guardrail configs.get: Get info about a guardrail configuration.update: Update model metadata.
nmp guardrail configs create#
Create a new guardrail config.
Required fields: name
Examples:
nmp guardrail configs create --input-file config.json
nmp guardrail configs create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp guardrail configs create --input-file -
nmp guardrail configs create --<option> "value"
Usage:
$ nmp guardrail configs create [OPTIONS]
Options:
--workspace--name: The name of the guardrail config--data: Guardrail configuration data (JSON string)--description: Description of the guardrail config
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp guardrail configs delete#
Delete a guardrail config.
Usage:
$ nmp guardrail configs delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp guardrail configs list#
List available guardrail configs.
Lists guardrail configs for a specific workspace.
Usage:
$ nmp guardrail configs list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: created_at, -created_at, name, -name]--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp guardrail configs get#
Get info about a guardrail configuration.
Usage:
$ nmp guardrail configs get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp guardrail configs update#
Update model metadata.
If the request body has an empty field, keep the old value.
Examples:
nmp guardrail configs update <name> --input-file config.json
nmp guardrail configs update <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp guardrail configs update <name> --input-file -
nmp guardrail configs update <name> --<option> "value"
Usage:
$ nmp guardrail configs update [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--data: Guardrail configuration data (JSON string)--description: Description of the guardrail config
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp iam#
Iam operations
Usage:
$ nmp iam [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
role-bindings: Manage role_bindings
nmp iam role-bindings#
Manage role_bindings
Usage:
$ nmp iam role-bindings [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create a new role binding (Platform Admin only)delete: Revoke a role binding (Platform Admin only)list: List all role bindings (Platform Admin only)get: Get a specific role binding (Platform Admin only)
nmp iam role-bindings create#
Create a new role binding (Platform Admin only)
Required fields: principal, role
Examples:
nmp iam role-bindings create --input-file config.json
nmp iam role-bindings create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp iam role-bindings create --input-file -
nmp iam role-bindings create --<option> "value"
Usage:
$ nmp iam role-bindings create [OPTIONS]
Options:
--principal: The principal identifier (email, user ID, or group ID)--role: The role name (e.g., ‘Viewer’, ‘Editor’, ‘Admin’)--wait-role-propagation: If true, wait for role to propagate before returning (default: true). Set to false for bulk operations.--workspace: The workspace this binding applies to. None for platform-level roles.
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp iam role-bindings delete#
Revoke a role binding (Platform Admin only)
Usage:
$ nmp iam role-bindings delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--wait-role-propagation: If true, wait for role to propagate before returning (default: true). Set to false for bulk operations.
Help:
--help: Show this message and exit.
nmp iam role-bindings list#
List all role bindings (Platform Admin only)
Usage:
$ nmp iam role-bindings list [OPTIONS]
Options:
--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--search--sort: The field to sort by. To sort in decreasing order, use-in front of the field name.--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp iam role-bindings get#
Get a specific role binding (Platform Admin only)
Usage:
$ nmp iam role-bindings get [OPTIONS] NAME
Arguments:
<NAME>
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference#
Inference operations
Usage:
$ nmp inference [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
deployment-configs: Manage deployment_configsdeployments: Manage deploymentsgateway: Gateway operationsmodels: Manage modelsproviders: Manage providers
nmp inference deployment-configs#
Manage deployment_configs
Usage:
$ nmp inference deployment-configs [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create a new ModelDeploymentConfig (version 1).delete: Delete all versions of a ModelDeploymentConfig.list: List ModelDeploymentConfigs for a specific workspace.get: Get the latest version of a ModelDeploymentConfig.update: Update a ModelDeploymentConfig (creates a new immutable…versions: Manage versions
nmp inference deployment-configs create#
Create a new ModelDeploymentConfig (version 1).
Required fields: name, nim_deployment
Examples:
nmp inference deployment-configs create --input-file config.json
nmp inference deployment-configs create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp inference deployment-configs create --input-file -
nmp inference deployment-configs create --<option> "value"
Usage:
$ nmp inference deployment-configs create [OPTIONS]
Options:
--workspace--name: Name of the deployment configuration. Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.--nim-deployment: Configuration for NIM-based model deployment. (JSON string)--description: Optional description of the deployment configuration--model-entity-id: Optional reference to the base model entity ID for this deployment--project: The URN of the project associated with this deployment configuration
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference deployment-configs delete#
Delete all versions of a ModelDeploymentConfig.
This operation will fail with 409 Conflict if any ModelDeployments currently reference this config and are not in DELETED status. Delete or wait for dependent deployments to reach DELETED status before deleting the config.
Usage:
$ nmp inference deployment-configs delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp inference deployment-configs list#
List ModelDeploymentConfigs for a specific workspace.
Returns only the latest version of each config.
Usage:
$ nmp inference deployment-configs list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort: The field to sort by. To sort in decreasing order, use-in front of the field name.--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence.
Filter deployment configs on various criteria.
--filter.model-entity-id--filter.project--filter.workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str} updated_at: {gte: str, lte: str}
Search deployment configs by name and description.
--search.description--search.name
nmp inference deployment-configs get#
Get the latest version of a ModelDeploymentConfig.
Usage:
$ nmp inference deployment-configs get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference deployment-configs update#
Update a ModelDeploymentConfig (creates a new immutable version).
Required fields: nim_deployment
Examples:
nmp inference deployment-configs update <name> --input-file config.json
nmp inference deployment-configs update <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp inference deployment-configs update <name> --input-file -
nmp inference deployment-configs update <name> --<option> "value"
Usage:
$ nmp inference deployment-configs update [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--nim-deployment: Configuration for NIM-based model deployment. (JSON string)--description: Optional description of the deployment configuration--model-entity-id: Optional reference to the base model entity ID for this deployment
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference deployment-configs versions#
Manage versions
Usage:
$ nmp inference deployment-configs versions [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
delete: Delete a specific version of a ModelDeploymentConfig.list: List all versions of a ModelDeploymentConfig.get: Get a specific version of a ModelDeploymentConfig.
nmp inference deployment-configs versions delete#
Delete a specific version of a ModelDeploymentConfig.
This operation will fail with 409 Conflict if any ModelDeployments currently reference this specific version and are not in DELETED status. Delete or wait for dependent deployments to reach DELETED status before deleting the config version.
Usage:
$ nmp inference deployment-configs versions delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--config
Help:
--help: Show this message and exit.
nmp inference deployment-configs versions list#
List all versions of a ModelDeploymentConfig.
Usage:
$ nmp inference deployment-configs versions list [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp inference deployment-configs versions get#
Get a specific version of a ModelDeploymentConfig.
Usage:
$ nmp inference deployment-configs versions get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--config
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference deployments#
Manage deployments
Usage:
$ nmp inference deployments [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create a new ModelDeployment (version 1).delete: Delete all versions of a ModelDeployment.list: List ModelDeployments for a specific workspace.list-models: Get Latest ModelDeployment’s Model Entities from Entity…get: Get the latest version of a ModelDeployment.update: Update a ModelDeployment (creates a new immutable version).update-status: Update the status of a ModelDeployment (mutable operation).versions: Manage versions
nmp inference deployments create#
Create a new ModelDeployment (version 1).
Required fields: config, name
Examples:
nmp inference deployments create --input-file config.json
nmp inference deployments create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp inference deployments create --input-file -
nmp inference deployments create --<option> "value"
Usage:
$ nmp inference deployments create [OPTIONS]
Options:
--workspace--config: Reference to the ModelDeploymentConfig name--name: Name of the deployment. Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.--config-version <INTEGER>: Reference to a specific ModelDeploymentConfig version. If not specified, uses latest.--project: The URN of the project associated with this deployment
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference deployments delete#
Delete all versions of a ModelDeployment.
If the deployment is in any state other than DELETED, this will set its status to DELETING. The models controller will then:
Delete the infrastructure (e.g., K8s NimService)
Update the status to DELETED
If the deployment is already in DELETED status, calling delete again will permanently remove it from the database.
Returns:
202 Accepted: Deployment marked for deletion (status set to DELETING)
204 No Content: Deployment permanently removed from database (was already DELETED)
404 Not Found: Deployment doesn’t exist
Usage:
$ nmp inference deployments delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp inference deployments list#
List ModelDeployments for a specific workspace.
By default, returns only the latest version of each deployment.
Usage:
$ nmp inference deployments list [OPTIONS]
Options:
--workspace--all-versions: If true, return all versions of each deployment. If false (default), return only the latest version.--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort: The field to sort by. To sort in decreasing order, use-in front of the field name.--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence.
Filter deployments on various criteria.
--filter.config--filter.model-provider-id--filter.project--filter.status--filter.workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str} updated_at: {gte: str, lte: str}
Search deployments by name and status message.
--search.name--search.status-message
nmp inference deployments list-models#
Get Latest ModelDeployment’s Model Entities from Entity Store.
This provides the API contract that NIMs expect from Entity Store today, for pulling LoRAs, but enables us to enforce AuthZ boundaries.
TODO: Implement model entity retrieval based on deployment config.
Usage:
$ nmp inference deployments list-models [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp inference deployments get#
Get the latest version of a ModelDeployment.
Usage:
$ nmp inference deployments get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference deployments update#
Update a ModelDeployment (creates a new immutable version).
Required fields: config
Examples:
nmp inference deployments update <name> --input-file config.json
nmp inference deployments update <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp inference deployments update <name> --input-file -
nmp inference deployments update <name> --<option> "value"
Usage:
$ nmp inference deployments update [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--config: Reference to the ModelDeploymentConfig name--config-version <INTEGER>: Reference to a specific ModelDeploymentConfig version. If not specified, uses latest.
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference deployments update-status#
Update the status of a ModelDeployment (mutable operation).
If version is not specified, updates the latest version.
Required fields: status
Examples:
nmp inference deployments update-status <name> --input-file config.json
nmp inference deployments update-status <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp inference deployments update-status <name> --input-file -
nmp inference deployments update-status <name> --<option> "value"
Usage:
$ nmp inference deployments update-status [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--status <CHOICE>: Status enum for ModelDeployment objects. [possible values: UNKNOWN, CREATED, PENDING, READY, ERROR, DELETING, DELETED, LOST]--version--model-provider-id: Optional reference to the auto-created ModelProvider workspace/name (format: workspace/name)--status-message: Detailed status message
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference deployments versions#
Manage versions
Usage:
$ nmp inference deployments versions [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
delete: Delete a specific version of a ModelDeployment.list: List all versions of a ModelDeployment.get: Get a specific version of a ModelDeployment.
nmp inference deployments versions delete#
Delete a specific version of a ModelDeployment.
If the deployment is in any state other than DELETED, this will set its status to DELETING. The models controller will then:
Delete the infrastructure (e.g., K8s NimService)
Update the status to DELETED
If the deployment is already in DELETED status, calling delete again will permanently remove it from the database.
Returns:
202 Accepted: Deployment version marked for deletion (status set to DELETING)
204 No Content: Deployment version permanently removed from database (was already DELETED)
404 Not Found: Deployment version doesn’t exist
Usage:
$ nmp inference deployments versions delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--deployment
Help:
--help: Show this message and exit.
nmp inference deployments versions list#
List all versions of a ModelDeployment.
Usage:
$ nmp inference deployments versions list [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp inference deployments versions get#
Get a specific version of a ModelDeployment.
Usage:
$ nmp inference deployments versions get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--deployment
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference gateway#
Gateway operations
Usage:
$ nmp inference gateway [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
model: Manage modelopenai: Openai operationsprovider: Manage provider
nmp inference gateway model#
Manage model
Usage:
$ nmp inference gateway model [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
delete: Proxy requests to model entity inference endpoints.get: Proxy requests to model entity inference endpoints.patch: Proxy requests to model entity inference endpoints.post: Proxy requests to model entity inference endpoints.put: Proxy requests to model entity inference endpoints.
nmp inference gateway model delete#
Proxy requests to model entity inference endpoints.
This is a stub implementation that returns request details.
Usage:
$ nmp inference gateway model delete [OPTIONS] TRAILING_URI
Arguments:
<TRAILING_URI>
Options:
--workspace--name
Help:
--help: Show this message and exit.
nmp inference gateway model get#
Proxy requests to model entity inference endpoints.
This is a stub implementation that returns request details.
Usage:
$ nmp inference gateway model get [OPTIONS] TRAILING_URI
Arguments:
<TRAILING_URI>
Options:
--workspace--name
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference gateway model patch#
Proxy requests to model entity inference endpoints.
This is a stub implementation that returns request details.
Required fields: name
Examples:
nmp inference gateway model patch <trailing_uri> --input-file config.json
nmp inference gateway model patch <trailing_uri> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp inference gateway model patch <trailing_uri> --input-file -
nmp inference gateway model patch <trailing_uri> --<option> "value"
Usage:
$ nmp inference gateway model patch [OPTIONS] TRAILING_URI
Arguments:
<TRAILING_URI>
Options:
--workspace--name--body: JSON string
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference gateway model post#
Proxy requests to model entity inference endpoints.
This is a stub implementation that returns request details.
Required fields: name
Examples:
nmp inference gateway model post <trailing_uri> --input-file config.json
nmp inference gateway model post <trailing_uri> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp inference gateway model post <trailing_uri> --input-file -
nmp inference gateway model post <trailing_uri> --<option> "value"
Usage:
$ nmp inference gateway model post [OPTIONS] TRAILING_URI
Arguments:
<TRAILING_URI>
Options:
--workspace--name--body: JSON string
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference gateway model put#
Proxy requests to model entity inference endpoints.
This is a stub implementation that returns request details.
Required fields: name
Examples:
nmp inference gateway model put <trailing_uri> --input-file config.json
nmp inference gateway model put <trailing_uri> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp inference gateway model put <trailing_uri> --input-file -
nmp inference gateway model put <trailing_uri> --<option> "value"
Usage:
$ nmp inference gateway model put [OPTIONS] TRAILING_URI
Arguments:
<TRAILING_URI>
Options:
--workspace--name--body: JSON string
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference gateway openai#
Openai operations
Usage:
$ nmp inference gateway openai [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
v1: V1 operations
nmp inference gateway openai v1#
V1 operations
Usage:
$ nmp inference gateway openai v1 [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
models: Manage models
nmp inference gateway openai v1 models
Manage models
Usage:
$ nmp inference gateway openai v1 models [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
get: Retrieve information about a specific OpenAI-compatible…list: This endpoint aggregates models from all model entities…
nmp inference gateway openai v1 models get
Retrieve information about a specific OpenAI-compatible model.
Workspace is always taken from the URL path; name may be model_entity_name or workspace/model_entity_name (workspace prefix is ignored).
Usage:
$ nmp inference gateway openai v1 models get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference gateway openai v1 models list
This endpoint aggregates models from all model entities and returns them in OpenAI’s list models format. Each model ID is the model entity identifier in format workspace/model_entity_name.
Usage:
$ nmp inference gateway openai v1 models list [OPTIONS]
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp inference gateway provider#
Manage provider
Usage:
$ nmp inference gateway provider [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
delete: Proxy requests to provider inference endpoints.get: Proxy requests to provider inference endpoints.patch: Proxy requests to provider inference endpoints.post: Proxy requests to provider inference endpoints.put: Proxy requests to provider inference endpoints.ready: Check if a model provider is registered in the gateway’s…
nmp inference gateway provider delete#
Proxy requests to provider inference endpoints.
Usage:
$ nmp inference gateway provider delete [OPTIONS] TRAILING_URI
Arguments:
<TRAILING_URI>
Options:
--workspace--name
Help:
--help: Show this message and exit.
nmp inference gateway provider get#
Proxy requests to provider inference endpoints.
Usage:
$ nmp inference gateway provider get [OPTIONS] TRAILING_URI
Arguments:
<TRAILING_URI>
Options:
--workspace--name
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference gateway provider patch#
Proxy requests to provider inference endpoints.
Required fields: name
Examples:
nmp inference gateway provider patch <trailing_uri> --input-file config.json
nmp inference gateway provider patch <trailing_uri> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp inference gateway provider patch <trailing_uri> --input-file -
nmp inference gateway provider patch <trailing_uri> --<option> "value"
Usage:
$ nmp inference gateway provider patch [OPTIONS] TRAILING_URI
Arguments:
<TRAILING_URI>
Options:
--workspace--name--body: JSON string
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference gateway provider post#
Proxy requests to provider inference endpoints.
Required fields: name
Examples:
nmp inference gateway provider post <trailing_uri> --input-file config.json
nmp inference gateway provider post <trailing_uri> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp inference gateway provider post <trailing_uri> --input-file -
nmp inference gateway provider post <trailing_uri> --<option> "value"
Usage:
$ nmp inference gateway provider post [OPTIONS] TRAILING_URI
Arguments:
<TRAILING_URI>
Options:
--workspace--name--body: JSON string
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference gateway provider put#
Proxy requests to provider inference endpoints.
Required fields: name
Examples:
nmp inference gateway provider put <trailing_uri> --input-file config.json
nmp inference gateway provider put <trailing_uri> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp inference gateway provider put <trailing_uri> --input-file -
nmp inference gateway provider put <trailing_uri> --<option> "value"
Usage:
$ nmp inference gateway provider put [OPTIONS] TRAILING_URI
Arguments:
<TRAILING_URI>
Options:
--workspace--name--body: JSON string
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference gateway provider ready#
Check if a model provider is registered in the gateway’s cache.
This is a lightweight endpoint that only checks the gateway’s internal state, without making any requests to the actual provider backend. Use this to verify the gateway is ready to route requests to a provider after deployment.
Returns: 200 OK with provider info if the provider is registered 404 Not Found if the provider is not yet in the gateway’s cache
Usage:
$ nmp inference gateway provider ready [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference models#
Manage models
Usage:
$ nmp inference models [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
get: Retrieve information about a specific OpenAI-compatible…list: This endpoint aggregates models from all model entities…
nmp inference models get#
Retrieve information about a specific OpenAI-compatible model.
Workspace is always taken from the URL path; name may be model_entity_name or workspace/model_entity_name (workspace prefix is ignored).
Usage:
$ nmp inference models get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference models list#
This endpoint aggregates models from all model entities and returns them in OpenAI’s list models format. Each model ID is the model entity identifier in format workspace/model_entity_name.
Usage:
$ nmp inference models list [OPTIONS]
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp inference providers#
Manage providers
Usage:
$ nmp inference providers [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create a new model provider.delete: Delete a model provider by workspace and name.list: List model providers for a specific workspace.get: Get a model provider by workspace and name.update: Create or update a model provider.update-status: Update status-related fields of a model provider.
nmp inference providers create#
Create a new model provider.
Required fields: host_url, name
Examples:
nmp inference providers create --input-file config.json
nmp inference providers create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp inference providers create --input-file -
nmp inference providers create --<option> "value"
Usage:
$ nmp inference providers create [OPTIONS]
Options:
--workspace--host-url: The network endpoint URL for the model provider--name: Name of the model provider. Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.--api-key-secret-name: Reference to an API key secret stored in the Secrets service. Create the secret first via secrets API, then pass the secret name here.--default-extra-body: Default body parameters for inference requests. Can be overridden by user requests. (JSON string)--default-extra-headers: Default headers for inference requests. Can be overridden by user requests. (JSON string)--description: Optional description of the model provider--enabled-models: Optional list of specific models to enable from this provider (can be repeated)--model-deployment-id: Optional reference to the ModelDeployment ID if this provider is being auto-created for a deployment--project: The URN of the project associated with this model provider--required-extra-body: Required body parameters for inference requests. Cannot be overridden by user requests. (JSON string)--required-extra-headers: Required headers for inference requests. Cannot be overridden by user requests. (JSON string)--status <CHOICE>: Status enum for ModelProvider objects. [possible values: UNKNOWN, CREATED, PENDING, READY, ERROR, DELETING, DELETED, LOST]--status-message: Status message
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference providers delete#
Delete a model provider by workspace and name.
Usage:
$ nmp inference providers delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp inference providers list#
List model providers for a specific workspace.
Usage:
$ nmp inference providers list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: name, -name, created_at, -created_at, updated_at, -updated_at, status, -status]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence.
Filter model providers on various criteria.
--filter.model-deployment-id--filter.project--filter.status--filter.workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str} updated_at: {gte: str, lte: str}
Search model providers by name, description, and host URL.
--search.description--search.host-url--search.name
nmp inference providers get#
Get a model provider by workspace and name.
Usage:
$ nmp inference providers get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference providers update#
Create or update a model provider.
Required fields: host_url
Examples:
nmp inference providers update <name> --input-file config.json
nmp inference providers update <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp inference providers update <name> --input-file -
nmp inference providers update <name> --<option> "value"
Usage:
$ nmp inference providers update [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--host-url: The network endpoint URL for the model provider--api-key-secret-name: Reference to an API key secret stored in the Secrets service. Create the secret first via secrets API, then pass the secret name here.--default-extra-body: Default body parameters for inference requests. Can be overridden by user requests. (JSON string)--default-extra-headers: Default headers for inference requests. Can be overridden by user requests. (JSON string)--description: Optional description of the model provider--enabled-models: Optional list of specific models to enable from this provider (can be repeated)--model-deployment-id: Optional reference to the ModelDeployment ID if this provider is associated with a deployment--project: The URN of the project associated with this model provider--required-extra-body: Required body parameters for inference requests. Cannot be overridden by user requests. (JSON string)--required-extra-headers: Required headers for inference requests. Cannot be overridden by user requests. (JSON string)--status <CHOICE>: Status enum for ModelProvider objects. [possible values: UNKNOWN, CREATED, PENDING, READY, ERROR, DELETING, DELETED, LOST]--status-message: Status message
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp inference providers update-status#
Update status-related fields of a model provider.
This endpoint supports partial updates for fields managed by Models Controller:
model_deployment_id
served_models
status
status_message
If status is provided without status_message, status_message will be set to empty string.
Examples:
nmp inference providers update-status <name> --input-file config.json
nmp inference providers update-status <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp inference providers update-status <name> --input-file -
nmp inference providers update-status <name> --<option> "value"
Usage:
$ nmp inference providers update-status [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--model-deployment-id: Reference to the ModelDeployment ID if this provider is associated with a deployment--served-models: List of models served by this provider with routing information for IGW (JSON string)--status <CHOICE>: Status enum for ModelProvider objects. [possible values: UNKNOWN, CREATED, PENDING, READY, ERROR, DELETING, DELETED, LOST]--status-message: Status message. If status is provided without status_message, defaults to empty string.
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp jobs#
Manage jobs
Usage:
$ nmp jobs [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
cancel: Cancel a platform job.create: Create a new platform job.delete: Delete a platform job.get-logs: Get paginated logs for a platform job.get-status: Get the status of a platform job.list: List platform jobs with filtering and pagination.list-execution-profiles: Get all currently configured execution profiles.pause: Pause a platform job.resume: Resume a paused platform job.get: Get a platform job by name.update-status-details: Update the status details of a platform job.results: Manage resultssteps: Manage stepstasks: Manage tasks
nmp jobs cancel#
Cancel a platform job.
Usage:
$ nmp jobs cancel [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp jobs create#
Create a new platform job.
Required fields: platform_spec, source, spec
Examples:
nmp jobs create --input-file config.json
nmp jobs create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp jobs create --input-file -
nmp jobs create --<option> "value"
Usage:
$ nmp jobs create [OPTIONS]
Options:
--workspace--platform-spec: Specification for a platform job, containing steps and secrets. (JSON string)--source--spec: JSON string--custom-fields: JSON string--description--name--ownership: JSON string--project
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp jobs delete#
Delete a platform job.
Usage:
$ nmp jobs delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp jobs get-logs#
Get paginated logs for a platform job.
Usage:
$ nmp jobs get-logs [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--attempt-id <INTEGER>: Filter logs by job attempt ID--limit <INTEGER>: Maximum number of logs to return--page-cursor: Page cursor--step-id: Filter logs by step name--task-id: Filter logs by task ID--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp jobs get-status#
Get the status of a platform job.
Usage:
$ nmp jobs get-status [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp jobs list#
List platform jobs with filtering and pagination.
Usage:
$ nmp jobs list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: created_at, -created_at, updated_at, -updated_at]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str} updated_at: {gte: str, lte: str}
Filter jobs on various criteria.
--filter.name--filter.project--filter.source--filter.status--filter.workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str} updated_at: {gte: str, lte: str}
Search jobs using substring matching. You can combine multiple search fields and filters. For example:
--search.name training: searches all jobs with ‘training’ in the name.--search.name training,eval: searches all jobs with ‘training’ OR ‘eval’ in the name.
--search.name--search.project
nmp jobs list-execution-profiles#
Get all currently configured execution profiles.
Usage:
$ nmp jobs list-execution-profiles [OPTIONS]
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp jobs pause#
Pause a platform job.
Usage:
$ nmp jobs pause [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp jobs resume#
Resume a paused platform job.
Usage:
$ nmp jobs resume [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp jobs get#
Get a platform job by name.
Usage:
$ nmp jobs get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp jobs update-status-details#
Update the status details of a platform job.
Required fields: body
Examples:
nmp jobs update-status-details <name> --input-file config.json
nmp jobs update-status-details <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp jobs update-status-details <name> --input-file -
nmp jobs update-status-details <name> --<option> "value"
Usage:
$ nmp jobs update-status-details [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--body: JSON string
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp jobs results#
Manage results
Usage:
$ nmp jobs results [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create a new result for a job.download: Download a job result file.list: List results for a job.get: Get a specific job result.
nmp jobs results create#
Create a new result for a job.
Required fields: job, artifact_storage_type, artifact_url
Examples:
nmp jobs results create <name> --input-file config.json
nmp jobs results create <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp jobs results create <name> --input-file -
nmp jobs results create <name> --<option> "value"
Usage:
$ nmp jobs results create [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job--artifact-storage-type <CHOICE>: [possible values: fileset]--artifact-url
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp jobs results download#
Download a job result file.
Usage:
$ nmp jobs results download [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp jobs results list#
List results for a job.
Usage:
$ nmp jobs results list [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--sort <CHOICE>: The field to sort by. [possible values: created_at, -created_at, updated_at, -updated_at]
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp jobs results get#
Get a specific job result.
Usage:
$ nmp jobs results get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp jobs steps#
Manage steps
Usage:
$ nmp jobs steps [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
list: List job steps with pagination and filtering.get: Get a specific job step.update-status: Update a job step status.
nmp jobs steps list#
List job steps with pagination and filtering.
Usage:
$ nmp jobs steps list [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: created_at, -created_at, updated_at, -updated_at]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: status: object
Filter steps on various criteria.
--filter.job--filter.source
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp jobs steps get#
Get a specific job step.
Usage:
$ nmp jobs steps get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp jobs steps update-status#
Update a job step status.
Required fields: job, status
Examples:
nmp jobs steps update-status <name> --input-file config.json
nmp jobs steps update-status <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp jobs steps update-status <name> --input-file -
nmp jobs steps update-status <name> --<option> "value"
Usage:
$ nmp jobs steps update-status [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job--status <CHOICE>: Enumeration of possible job statuses. This enum represents the various states a job can be in during its lifecycle, from creation to a terminal state. [possible values: created, pending, active, cancelled, cancelling, error, completed, paused, pausing, resuming]--error-details: Optional error details related to the status update. (JSON string)--status-details: Optional status details related to the status update. (JSON string)
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp jobs tasks#
Manage tasks
Usage:
$ nmp jobs tasks [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create-or-update: Update a job step task.list: List tasks for a job step.get: Get a specific job step task.
nmp jobs tasks create-or-update#
Update a job step task.
Required fields: job, step
Examples:
nmp jobs tasks create-or-update <name> --input-file config.json
nmp jobs tasks create-or-update <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp jobs tasks create-or-update <name> --input-file -
nmp jobs tasks create-or-update <name> --<option> "value"
Usage:
$ nmp jobs tasks create-or-update [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job--step--error-details: JSON string--error-stack--status <CHOICE>: Enumeration of possible job statuses. This enum represents the various states a job can be in during its lifecycle, from creation to a terminal state. [possible values: created, pending, active, cancelled, cancelling, error, completed, paused, pausing, resuming]--status-details: JSON string
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp jobs tasks list#
List tasks for a job step.
Usage:
$ nmp jobs tasks list [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp jobs tasks get#
Get a specific job step task.
Usage:
$ nmp jobs tasks get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job--step
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp members#
Manage members
Usage:
$ nmp members [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Add a new member to the workspace with specified roles.delete: Remove a member from the workspace by revoking all their…list: List all members of a workspace with their roles.update: Update the roles for a workspace member.
nmp members create#
Add a new member to the workspace with specified roles.
This creates role bindings for the specified principal with the given roles. By
default, this endpoint waits for the roles to propagate before returning. Use
wait_role_propagation=false to skip waiting (useful for bulk operations).
Examples:
POST /apis/entities/v2/workspaces/ml-team/members
`{"principal": "user@example.com", "roles": ["Editor"]}`
Required fields: principal
Examples:
nmp members create --input-file config.json
nmp members create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp members create --input-file -
nmp members create --<option> "value"
Usage:
$ nmp members create [OPTIONS]
Options:
--workspace--principal: The principal identifier (email, user ID, or group ID)--wait-role-propagation: If true, wait for roles to propagate before returning (default: true). Set to false for bulk operations.--roles: List of roles to grant to the principal (can be repeated)
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp members delete#
Remove a member from the workspace by revoking all their roles.
This revokes all active role bindings for the principal in the workspace. By
default, this endpoint waits for all roles to be revoked before returning. Use
wait_role_propagation=false to skip waiting (useful for bulk operations).
Examples:
DELETE /apis/entities/v2/workspaces/ml-team/members/user@example.com
Usage:
$ nmp members delete [OPTIONS] PRINCIPAL_ID
Arguments:
<PRINCIPAL_ID>
Options:
--workspace--wait-role-propagation: If true, wait for roles to propagate before returning (default: true). Set to false for bulk operations.
Help:
--help: Show this message and exit.
nmp members list#
List all members of a workspace with their roles.
Returns a list of all principals with active role bindings in the workspace.
Examples:
GET /apis/entities/v2/workspaces/ml-team/members
Usage:
$ nmp members list [OPTIONS]
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp members update#
Update the roles for a workspace member.
This will revoke existing roles not in the new list and add new roles. By
default, this endpoint waits for the roles to propagate before returning. Use
wait_role_propagation=false to skip waiting (useful for bulk operations).
Examples:
PUT /apis/entities/v2/workspaces/ml-team/members/user@example.com
`{"roles": ["Viewer", "Editor"]}`
Required fields: roles
Examples:
nmp members update <principal_id> --input-file config.json
nmp members update <principal_id> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp members update <principal_id> --input-file -
nmp members update <principal_id> --<option> "value"
Usage:
$ nmp members update [OPTIONS] PRINCIPAL_ID
Arguments:
<PRINCIPAL_ID>
Options:
--workspace--roles: Updated list of roles for the principal (can be repeated)--wait-role-propagation: If true, wait for roles to propagate before returning (default: true). Set to false for bulk operations.
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp models#
Manage models
Usage:
$ nmp models [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create a new model entity.delete: Delete Model entity.list: List Models endpoint with filtering, search, pagination,…get: Get Model by Workspace and Name.update: Update Model metadata.adapters: Manage adapters
nmp models create#
Create a new model entity.
This endpoint creates a new Model Entity in the Models service database. The Model Entity will be registered for use within the platform.
Required fields: name
Examples:
nmp models create --input-file config.json
nmp models create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp models create --input-file -
nmp models create --<option> "value"
Usage:
$ nmp models create [OPTIONS]
Options:
--workspace--name: Name of the model entity. Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.--api-endpoint: Data about an inference endpoint. (JSON string)--base-model: Link to another model which is used as a base for the current model--custom-fields: Custom fields for additional metadata (JSON string)--description: Optional description of the model--fileset: A set of checkpoint files, configs, and other auxiliary info associated with this model - expected format {workspace}/{fileset_name}--finetuning-type <CHOICE>: Finetuning types. [possible values: lora_merged, all_weights, last_layer, top_layers, gradual_unfreezing, bias_only, attention_only, lora, qlora, adalora, dora, lora_plus, prompt_tuning, prefix_tuning, p_tuning, p_tuning_v2, soft_prompt, ppo, dpo, cdpo, ipo, orpo, kto, rrhf, grpo]--model-providers: List of ModelProvider workspace/name resource names that provide inference for this Model Entity (can be repeated)--ownership: Ownership information for the model (JSON string)--project: The URN of the project associated with this model entity--prompt: Configuration for prompt engineering. (JSON string)--spec: Detailed specification for a model. (JSON string)--trust-remote-code: Whether to trust remote code for the checkpoint. Some models without support in certain libraries such as Transformers require additional custom Python code to execute. Due to security ramifications of running arbitrary code, this can only be set to true on one of the following conditions: (1) the model’s fileset’s source is pre-approved in the platform config, or (2) the user creating this model is an administrator.
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp models delete#
Delete Model entity.
Permanently deletes a model entity from the platform.
Usage:
$ nmp models delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp models list#
List Models endpoint with filtering, search, pagination, and sorting.
Supports filter parameters for various criteria (including peft, custom fields), search parameters for substring matching (name, base_model, peft, custom_property), pagination (page, page_size), sorting, and workspace filtering via query parameter.
Usage:
$ nmp models list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: -created_at, created_at, -updated_at, updated_at, -name, name]--verbose: Whether to include full spec details--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str}
Filter models on various criteria.
--filter.adapters--filter.base-model--filter.finetuning-type--filter.project--filter.prompt--filter.workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: adapters: {fileset: str, finetuning_type: Literal, name: str, created_at: str, description: str, enabled: bool, lora_config: LoraParam, updated_at: str} api_endpoint: {api_key: str, format: str, model_id: str, url: str} created_at: {gte: str, lte: str} custom_fields: dict[str, object] ownership: dict[str, object] prompt: {icl_few_shot_examples: str, inference_params: InferenceParamsParam, system_prompt: str, system_prompt_template: str} spec: {base_num_parameters: int, checkpoint_model_name: str, family: str, ffn_hidden_size: int, gated_mlp: bool, hidden_size: int, num_attention_heads: int, num_kv_heads: int, num_layers: int, precision: str, tied_embeddings: bool, vocab_size: int, chat_template: str, context_size: int, is_chat: bool, is_embedding_model: bool, linear_layers: , mamba_config: MambaConfig, minimum_gpus_all_weights: int, minimum_gpus_lora: int, moe_config: MoEConfig, num_virtual_tokens: int, sliding_window_config: SlidingWindowConfig, tool_call_config: ToolCallConfig} updated_at: {gte: str, lte: str}
Search models by name, description, and other fields. Supports JSON search (e.g. {"name":{"$like":"llama"}}) with operators: $eq, $like, $lt, $lte, $gt, $gte, $in, $nin, $and, $or, $not. Also supports bracket notation where bare values default to $like.
--search.id--search.base-model--search.description--search.fileset--search.name--search.project
nmp models get#
Get Model by Workspace and Name.
Returns the details of a specific model entity identified by its workspace and name.
Usage:
$ nmp models get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--verbose: Whether to include full spec details
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp models update#
Update Model metadata.
Updates the metadata of an existing model entity.
If the request body has an empty field, the old value is kept.
Examples:
nmp models update <name> --input-file config.json
nmp models update <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp models update <name> --input-file -
nmp models update <name> --<option> "value"
Usage:
$ nmp models update [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--verbose: Whether to include full spec details--api-endpoint: Data about an inference endpoint. (JSON string)--base-model: Link to another model which is used as a base for the current model--custom-fields: Custom fields for additional metadata (JSON string)--description: Optional description of the model--fileset: A set of checkpoint files, configs, and other auxiliary info associated with this model - expected format {workspace}/{fileset_name}--finetuning-type <CHOICE>: Finetuning types. [possible values: lora_merged, all_weights, last_layer, top_layers, gradual_unfreezing, bias_only, attention_only, lora, qlora, adalora, dora, lora_plus, prompt_tuning, prefix_tuning, p_tuning, p_tuning_v2, soft_prompt, ppo, dpo, cdpo, ipo, orpo, kto, rrhf, grpo]--model-providers: List of ModelProvider workspace/name resource names that provide inference for this Model Entity (can be repeated)--ownership: Ownership information for the model (JSON string)--prompt: Configuration for prompt engineering. (JSON string)--spec: Detailed specification for a model. (JSON string)--trust-remote-code: Whether to trust remote code for the checkpoint. Some models without support in certain libraries such as Transformers require additional custom Python code to execute. Due to security ramifications of running arbitrary code, this can only be set to true on one of the following conditions: (1) the model’s fileset’s source is pre-approved in the platform config, or (2) the user creating this model is an administrator.
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp models adapters#
Manage adapters
Usage:
$ nmp models adapters [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Adds an Adapter to the Modeldelete: Delete Adapter from Model entity.update: Update Adapter deployment or description.
nmp models adapters create#
Adds an Adapter to the Model
Required fields: fileset, finetuning_type, name
Examples:
nmp models adapters create <model_name> --input-file config.json
nmp models adapters create <model_name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp models adapters create <model_name> --input-file -
nmp models adapters create <model_name> --<option> "value"
Usage:
$ nmp models adapters create [OPTIONS] MODEL_NAME
Arguments:
<MODEL_NAME>
Options:
--workspace--fileset: Location where adapter files are stored - expected format {workspace}/{fileset_name}--finetuning-type <CHOICE>: Finetuning types. [possible values: lora_merged, all_weights, last_layer, top_layers, gradual_unfreezing, bias_only, attention_only, lora, qlora, adalora, dora, lora_plus, prompt_tuning, prefix_tuning, p_tuning, p_tuning_v2, soft_prompt, ppo, dpo, cdpo, ipo, orpo, kto, rrhf, grpo]--name: Name of the adapter. Name must be unique per ModelEntity. Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.--description: Optional description of the adapter--enabled: Whether to make this adapter available for inference post training--lora-config: Lora configuration specifics (JSON string)
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp models adapters delete#
Delete Adapter from Model entity.
Permanently deletes an adapter from a model entity, if it was deployed, it will be cleaned up automatically.
Usage:
$ nmp models adapters delete [OPTIONS] ADAPTER
Arguments:
<ADAPTER>
Options:
--workspace--model-name
Help:
--help: Show this message and exit.
nmp models adapters update#
Update Adapter deployment or description.
Required fields: model_name
Examples:
nmp models adapters update <adapter> --input-file config.json
nmp models adapters update <adapter> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp models adapters update <adapter> --input-file -
nmp models adapters update <adapter> --<option> "value"
Usage:
$ nmp models adapters update [OPTIONS] ADAPTER
Arguments:
<ADAPTER>
Options:
--workspace--model-name--description: Optional description of the adapter--enabled: Whether to make this adapter available for inference post training--fileset: Updated fileset for the adapter
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp projects#
Manage projects
Usage:
$ nmp projects [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create a new project in the given workspace.delete: Delete a project.list: List all projects in a workspace with pagination.get: Get a specific project by its workspace and name.update: Update a project’s description.
nmp projects create#
Create a new project in the given workspace.
Examples:
POST /apis/entities/v2/workspaces/default/projects
`{"name": "ml-project", "description": "Machine Learning project"}`
Required fields: name
Examples:
nmp projects create --input-file config.json
nmp projects create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp projects create --input-file -
nmp projects create --<option> "value"
Usage:
$ nmp projects create [OPTIONS]
Options:
--workspace--name: Project name (unique within workspace). Name must start with a lowercase letter, be 2-63 characters, and contain only lowercase letters, digits, and hyphens (no consecutive hyphens, cannot end with a hyphen).--description: Optional description of the project
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp projects delete#
Delete a project.
Examples:
DELETE /apis/entities/v2/workspaces/default/projects/ml-project
Usage:
$ nmp projects delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp projects list#
List all projects in a workspace with pagination.
Query Parameters:
page, page_size: Pagination
sort: Sort field
search: Advanced search filters
Examples:
GET /apis/entities/v2/workspaces/default/projects?sort=-created_at&page=1&page_size=10
Usage:
$ nmp projects list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number--page-size <INTEGER>: Items per page--search: Advanced search filter as JSON. Example:{"name":{"$like":"value"}}. Operators:$eq,$like,$lt,$lte,$gt,$gte,$in,$nin,$and,$or,$not. Also supports bracket notation: ?search[$like]=value. Relationship traversal: ?search[$exists]=true or ?search=value--sort <CHOICE>: Sort field [possible values: -created_at, created_at, -updated_at, updated_at, -name, name]--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp projects get#
Get a specific project by its workspace and name.
Examples:
GET /apis/entities/v2/workspaces/default/projects/ml-project
Usage:
$ nmp projects get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp projects update#
Update a project’s description.
Examples:
PUT /apis/entities/v2/workspaces/default/projects/ml-project
`{"description": "Updated description for ML project"}`
Examples:
nmp projects update <name> --input-file config.json
nmp projects update <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp projects update <name> --input-file -
nmp projects update <name> --<option> "value"
Usage:
$ nmp projects update [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--description: Updated description
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp safe-synthesizer#
Safe Synthesizer operations
Usage:
$ nmp safe-synthesizer [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
jobs: Manage jobs
nmp safe-synthesizer jobs#
Manage jobs
Usage:
$ nmp safe-synthesizer jobs [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
cancel: Cancel Jobcreate: Create Jobdelete: Delete Jobget-logs: Get Job Logsget-status: Get Job Statuslist: List Jobsget: Get Jobresults: Manage results
nmp safe-synthesizer jobs cancel#
Cancel Job
Usage:
$ nmp safe-synthesizer jobs cancel [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp safe-synthesizer jobs create#
Create Job
Required fields: spec
Examples:
nmp safe-synthesizer jobs create --input-file config.json
nmp safe-synthesizer jobs create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp safe-synthesizer jobs create --input-file -
nmp safe-synthesizer jobs create --<option> "value"
Usage:
$ nmp safe-synthesizer jobs create [OPTIONS]
Options:
--workspace--spec: Configuration model for Safe Synthesizer jobs. Used primarily internally to configure a run submitted to the NeMo Jobs Microservice. (JSON string)--custom-fields: JSON string--description--name--ownership: JSON string--project
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp safe-synthesizer jobs delete#
Delete Job
Usage:
$ nmp safe-synthesizer jobs delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp safe-synthesizer jobs get-logs#
Get Job Logs
Usage:
$ nmp safe-synthesizer jobs get-logs [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--limit <INTEGER>--page-cursor--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp safe-synthesizer jobs get-status#
Get Job Status
Usage:
$ nmp safe-synthesizer jobs get-status [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp safe-synthesizer jobs list#
List Jobs
Usage:
$ nmp safe-synthesizer jobs list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--sort <CHOICE>: The field to sort by. To sort in decreasing order, use-in front of the field name. [possible values: created_at, -created_at, updated_at, -updated_at]--all-pages: Fetch all pages
Filter Options:
--filter FILTER_JSON: Use –filter with JSON for complex/nested queries, or –filter. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: created_at: {gte: str, lte: str} updated_at: {gte: str, lte: str}
Filter jobs on various criteria.
--filter.name--filter.project--filter.status--filter.workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
Search Options:
--search SEARCH_JSON: Use –search with JSON for complex/nested queries, or –search. FIELD options for simple fields. Both can be combined, with field options taking precedence. JSON-only fields: name: object project: object
Search jobs using substring matching. You can combine multiple search fields and filters. For example:
--search.name training: searches all jobs with ‘training’ in the name.--search.project my-project: searches all jobs with ‘my-project’ in the project field.--search.name training,eval: searches all jobs with ‘training’ OR ‘eval’ in the name.--search.name training --search.project my-project: searches all jobs with ‘training’ in the name AND ‘my-project’ in the project.
nmp safe-synthesizer jobs get#
Get Job
Usage:
$ nmp safe-synthesizer jobs get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp safe-synthesizer jobs results#
Manage results
Usage:
$ nmp safe-synthesizer jobs results [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
download: Download Job Resultdownload-evaluation-report: Download Job Result Evaluation-Reportdownload-summary: Download Job Result Summarydownload-synthetic-data: Download Job Result Synthetic-Datalist: List Job Resultsget: Get Job Result
nmp safe-synthesizer jobs results download#
Download Job Result
Usage:
$ nmp safe-synthesizer jobs results download [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp safe-synthesizer jobs results download-evaluation-report#
Download Job Result Evaluation-Report
Usage:
$ nmp safe-synthesizer jobs results download-evaluation-report [OPTIONS] JOB
Arguments:
<JOB>
Options:
--workspace--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp safe-synthesizer jobs results download-summary#
Download Job Result Summary
Usage:
$ nmp safe-synthesizer jobs results download-summary [OPTIONS] JOB
Arguments:
<JOB>
Options:
--workspace--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp safe-synthesizer jobs results download-synthetic-data#
Download Job Result Synthetic-Data
Usage:
$ nmp safe-synthesizer jobs results download-synthetic-data [OPTIONS] JOB
Arguments:
<JOB>
Options:
--workspace--output-file, -o <PATH>: Output file path
Help:
--help: Show this message and exit.
nmp safe-synthesizer jobs results list#
List Job Results
Usage:
$ nmp safe-synthesizer jobs results list [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp safe-synthesizer jobs results get#
Get Job Result
Usage:
$ nmp safe-synthesizer jobs results get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--job
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp secrets#
Manage secrets
Usage:
$ nmp secrets [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
access: Access the value of a secret.create: Create a new secret.delete: Delete a secret.list: List available secretsget: Retrieve a secret by its name.update: Update a secret’s metadata and/or value.admin: Manage admin
nmp secrets access#
Access the value of a secret.
Usage:
$ nmp secrets access [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp secrets create#
Create a new secret.
Examples:
# Pass secret value directly
nmp secrets create --name my-secret --data "abc123"
# Read secret from a file
nmp secrets create --name my-secret --from-file ./secret.txt --description "API key for X"
# Read secret from stdin
cat secret.txt | nmp secrets create --name my-secret --from-file -
# Read secret from environment variable
echo "$API_KEY" | nmp secrets create --name my-secret --from-file -
Usage:
$ nmp secrets create [OPTIONS]
Options:
--workspace--from-file: Path to file containing the secret data. Use ‘-’ to read from stdin.--data: Secret value directly. Use –from-file for large or sensitive input.--name: The name of the secret to create--description: An optional description of the secret
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp secrets delete#
Delete a secret.
Usage:
$ nmp secrets delete [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
nmp secrets list#
List available secrets
Usage:
$ nmp secrets list [OPTIONS]
Options:
--workspace--page <INTEGER>: Page number.--page-size <INTEGER>: Page size.--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp secrets get#
Retrieve a secret by its name.
Usage:
$ nmp secrets get [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp secrets update#
Update a secret’s metadata and/or value.
Examples:
# Update secret value directly
nmp secrets update my-secret --data "new-value"
# Read secret from a file
nmp secrets update my-secret --from-file ./secret.txt --description "Updated!"
# Read secret from stdin
cat secret.txt | nmp secrets update my-secret --from-file -
# Read secret from environment variable
echo "$API_KEY" | nmp secrets update my-secret --from-file -
Usage:
$ nmp secrets update [OPTIONS] NAME
Arguments:
<NAME>
Options:
--workspace--from-file: Path to file containing the secret data. Use ‘-’ to read from stdin.--data: Secret value directly. Use –from-file for large or sensitive input.--description: An optional description of the secret
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp secrets admin#
Manage admin
Usage:
$ nmp secrets admin [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
rotate-encryption-keys: Rotate encryption keys for all platform secrets.
nmp secrets admin rotate-encryption-keys#
Rotate encryption keys for all platform secrets.
Usage:
$ nmp secrets admin rotate-encryption-keys [OPTIONS]
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp workspaces#
Manage workspaces
Usage:
$ nmp workspaces [OPTIONS] COMMAND [ARGS]...
Help:
--help: Show this message and exit.
Commands:
create: Create a new workspace.delete: Delete a workspace.list: List all workspaces with pagination.get: Get a specific workspace by ID.update: Update a workspace’s description.
nmp workspaces create#
Create a new workspace.
The creator is automatically granted Admin role on the workspace. By default,
this endpoint waits for the Admin role to propagate before returning. Use
wait_role_propagation=false to skip waiting (useful for bulk operations).
Examples:
POST /apis/entities/v2/workspaces
`{"name": "ml-team", "description": "Machine Learning Team workspace"}`
Required fields: name
Examples:
nmp workspaces create --input-file config.json
nmp workspaces create --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp workspaces create --input-file -
nmp workspaces create --<option> "value"
Usage:
$ nmp workspaces create [OPTIONS]
Options:
--name: Workspace name (unique identifier). Name must start with a lowercase letter, be 2-63 characters, and contain only lowercase letters, digits, and hyphens (no consecutive hyphens, cannot end with a hyphen).--wait-role-propagation: If true, wait for Admin role to propagate before returning (default: true). Set to false for bulk operations.--description: Optional description of the workspace
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp workspaces delete#
Delete a workspace.
This marks the workspace for deletion and returns immediately. The workspace will no longer be accessible via the API. An asynchronous cleanup controller will handle deletion of all entities and external resources.
Role bindings are immediately deleted to revoke access.
Examples:
DELETE /apis/entities/v2/workspaces/ml-team
Usage:
$ nmp workspaces delete [OPTIONS] NAME
Arguments:
<NAME>
Help:
--help: Show this message and exit.
nmp workspaces list#
List all workspaces with pagination.
When authentication is enabled, only workspaces the principal has access to are returned. Service principals and platform admins have access to all workspaces.
Query Parameters:
page, page_size: Pagination
sort: Sort field
search: Advanced search filters (JSON or bracket notation)
Examples:
GET /apis/entities/v2/workspaces?sort=-created_at&page=1&page_size=10
Usage:
$ nmp workspaces list [OPTIONS]
Options:
--page <INTEGER>: Page number--page-size <INTEGER>: Items per page--search: Advanced search filter as JSON. Example:{"name":{"$like":"value"}}. Operators:$eq,$like,$lt,$lte,$gt,$gte,$in,$nin,$and,$or,$not. Also supports bracket notation: ?search[$like]=value. Relationship traversal: ?search[$exists]=true or ?search=value--sort <CHOICE>: Sort field [possible values: created_at, -created_at, name, -name]--all-pages: Fetch all pages
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for the list of results. [possible values: table, json, yaml, markdown, csv, raw, code]--no-truncate: Don’t truncate long values in table/markdown/csv output.--output-columns, -c: Columns to display: ‘default’, ‘all’, or comma-separated names. Only affects table/csv/markdown formats.
nmp workspaces get#
Get a specific workspace by ID.
Examples:
GET /apis/entities/v2/workspaces/ml-team
Usage:
$ nmp workspaces get [OPTIONS] NAME
Arguments:
<NAME>
Help:
--help: Show this message and exit.
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]
nmp workspaces update#
Update a workspace’s description.
Examples:
PUT /apis/entities/v2/workspaces/ml-team
`{"description": "Updated description for ML Team"}`
Examples:
nmp workspaces update <name> --input-file config.json
nmp workspaces update <name> --input-data '{"field": "value"}'
echo '{"json": "data"}' | nmp workspaces update <name> --input-file -
nmp workspaces update <name> --<option> "value"
Usage:
$ nmp workspaces update [OPTIONS] NAME
Arguments:
<NAME>
Options:
--description: Updated description
Help:
--help: Show this message and exit.
Input Options:
--input-file: Path to JSON file (use ‘-’ for stdin)--input-data: Input data for the request (JSON or YAML)
Output Options:
--output-format, -f <CHOICE>: Output format for an entity. [possible values: json, yaml, raw, code]