Share via


PromptBasedEvaluatorDefinition Class

Definition

Prompt-based evaluator.

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

Constructors

Name Description
PromptBasedEvaluatorDefinition(String)

Initializes a new instance of PromptBasedEvaluatorDefinition.

Properties

Name Description
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)
PromptText

The prompt text used for evaluation.

Methods

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

Explicit Interface Implementations

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

Applies to