Share via


CodeBasedEvaluatorDefinition Class

Definition

Code-based evaluator definition using python code.

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

Constructors

Name Description
CodeBasedEvaluatorDefinition(String)

Initializes a new instance of CodeBasedEvaluatorDefinition.

Properties

Name Description
CodeText

Inline code text for the evaluator.

DataSchema

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

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

(Inherited from EvaluatorDefinition)
InitParameters

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

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

(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<CodeBasedEvaluatorDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<CodeBasedEvaluatorDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<EvaluatorDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from EvaluatorDefinition)
IJsonModel<EvaluatorDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from EvaluatorDefinition)
IPersistableModel<CodeBasedEvaluatorDefinition>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<CodeBasedEvaluatorDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<CodeBasedEvaluatorDefinition>.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