EndpointBasedEvaluatorDefinition Class

Definition

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.

public class EndpointBasedEvaluatorDefinition : Azure.AI.Projects.Evaluation.EvaluatorDefinition, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Evaluation.EndpointBasedEvaluatorDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Evaluation.EndpointBasedEvaluatorDefinition>
type EndpointBasedEvaluatorDefinition = class
    inherit EvaluatorDefinition
    interface IJsonModel<EndpointBasedEvaluatorDefinition>
    interface IPersistableModel<EndpointBasedEvaluatorDefinition>
Public Class EndpointBasedEvaluatorDefinition
Inherits EvaluatorDefinition
Implements IJsonModel(Of EndpointBasedEvaluatorDefinition), IPersistableModel(Of EndpointBasedEvaluatorDefinition)
Inheritance
EndpointBasedEvaluatorDefinition
Implements

Constructors

Name Description
EndpointBasedEvaluatorDefinition(String)

Initializes a new instance of EndpointBasedEvaluatorDefinition.

Properties

Name Description
ConnectionName

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).

DataSchema

The JSON schema (Draft 2020-12) for the evaluator's input data.

(Inherited from EvaluatorDefinition)
InitParameters

The JSON schema (Draft 2020-12) for the evaluator's input parameters.

(Inherited from EvaluatorDefinition)
Metrics

List of output metrics produced by this evaluator.

(Inherited from EvaluatorDefinition)

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<EndpointBasedEvaluatorDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<EndpointBasedEvaluatorDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<EvaluatorDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from EvaluatorDefinition)
IJsonModel<EvaluatorDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from EvaluatorDefinition)
IPersistableModel<EndpointBasedEvaluatorDefinition>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<EndpointBasedEvaluatorDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<EndpointBasedEvaluatorDefinition>.Write(ModelReaderWriterOptions)
IPersistableModel<EvaluatorDefinition>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from EvaluatorDefinition)
IPersistableModel<EvaluatorDefinition>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from EvaluatorDefinition)
IPersistableModel<EvaluatorDefinition>.Write(ModelReaderWriterOptions) (Inherited from EvaluatorDefinition)

Applies to