EndpointBasedEvaluatorDefinition interface

Package:

@azure/ai-projects

Endpoint-based evaluator definition. The customer owns and hosts an HTTP endpoint that implements the evaluation contract. The evaluator references a Project Connection by name; the connection stores the endpoint URL and credentials (API Key or Entra ID). At execution time, the service resolves the connection to obtain the endpoint URL and authentication details, then calls the endpoint for each evaluation row.

Extends

EvaluatorDefinition

Properties

connection_name	Name of the Project Connection that stores the endpoint URL and credentials. The connection must exist on the project and have a non-empty target URL. Supported auth types: ApiKey (sends api-key header) and AAD/Entra ID (acquires a bearer token via the project's Managed Identity).
type	The discriminator possible values: code, prompt, rubric, endpoint

Inherited Properties

data_schema	The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required.
init_parameters	The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required.
metrics	List of output metrics produced by this evaluator

Property Details

connection_name

Name of the Project Connection that stores the endpoint URL and credentials. The connection must exist on the project and have a non-empty target URL. Supported auth types: ApiKey (sends api-key header) and AAD/Entra ID (acquires a bearer token via the project's Managed Identity).

connection_name: string

Property Value

string

type

The discriminator possible values: code, prompt, rubric, endpoint

type: "endpoint"

Property Value

"endpoint"

Inherited Property Details

data_schema

The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required.

data_schema?: Record<string, unknown>

Property Value

Record<string, unknown>

Inherited From EvaluatorDefinition.data_schema

init_parameters

The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required.

init_parameters?: Record<string, unknown>

Property Value

Record<string, unknown>

Inherited From EvaluatorDefinition.init_parameters

metrics

List of output metrics produced by this evaluator

metrics?: Record<string, EvaluatorMetric>

Property Value

Record<string, EvaluatorMetric>

Inherited From EvaluatorDefinition.metrics