Target JSON Schema Reference#

When you create a target for an evaluation, you send a JSON data structure that contains the information for your target.

Important

Each target is uniquely identified by a combination of namespace and name. For example my-organization/my-target.

The following table contains selected field reference for the JSON data. For the full API reference, refer to Evaluator API.

Target JSON Fields#

Name

Description

Type

Valid Values or Child Objects

api_endpoint

The endpoint for a model.

Object

  • url

  • model_id

  • api_key

api_key

The key to access an API endpoint.

String

—

cached_outputs

Pre-generated data.

Object

  • files_url

context_ordering

The order for retrieved results.

String

  • asc

  • desc

custom_fields

An optional object that you can use to store additional information.

Object

—

files_url

The URL of a file that contains pre-generated data. Use hf://datasets/ as prefix for files stored in NeMo Data Store. For format information, refer to Using Custom Data.

String

—

id

The ID of the target. The ID is returned in the response when you create a target.

String

—

index_embedding_model

The NIM model for the embedding model to perform indexing of documents.

Object

  • api_endpoint

model

The NIM model for an evaluation.

Object

  • api_endpoint

model_id

The ID of the NIM model, as specified in Models.

String

—

name

An arbitrary name for to identify the target. If you don’t specify a name, the default is the ID associated with the target.

String

—

namespace

An arbitrary organization name, a vendor name, or any other text. If you don’t specify a namespace, the default is default.

String

—

pipeline

The pipeline for a retriever or RAG evaluation.

Object

  • query_embedding_model

  • index_embedding_model

  • reranker_model

  • top_k

  • retriever

  • model

  • context_ordering

query_embedding_model

The NIM model for the embedding model to perform querying.

Object

  • api_endpoint

rag

A RAG pipeline for an evaluation.

Object

  • pipeline

  • cached_outputs

reranker_model

The NIM model for the reranker model to perform reranking documents.

Object

  • api_endpoint

retriever

A retriever pipeline for an evaluation.

Object

  • pipeline

  • cached_outputs

top_k

The number of relevant documents to be retrieved based on the query, sorted descending by relevance score.

Integer

Any positive number. In practice, this value should usually be less than 100.

type

The type of the evaluation target.

String

  • cached_outputs

  • model

  • retriever

  • rag

url

The URL of a model endpoint.

String

—