Azure.AI.Projects.Evaluation Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| Name | Description |
|---|---|
| AgentClusterInsightRequest |
Insights on set of Agent Evaluation Results. |
| AgentClusterInsightResult |
Insights from the agent cluster analysis. |
| AgentTaxonomyInput |
Input configuration for the evaluation taxonomy when the input type is agent. |
| AzureAIAgentTarget |
Represents a target specifying an Azure AI agent. |
| AzureAIModelTarget |
Represents a target specifying an Azure AI model for operations requiring model selection. |
| AzureOpenAIModelConfiguration |
Azure OpenAI model configuration. The API version would be selected by the service for querying the model. |
| ChartCoordinate |
Coordinates for the analysis chart. |
| ClusterInsightResult |
Insights from the cluster analysis. |
| ClusterTokenUsage |
Token usage for cluster analysis. |
| CodeBasedEvaluatorDefinition |
Code-based evaluator definition using python code. |
| ContinuousEvaluationRuleAction |
Evaluation rule action for continuous evaluation. |
| CronTrigger |
Cron based trigger. |
| DailyRecurrenceSchedule |
Daily recurrence schedule. |
| EvalResult |
Result of the evaluation. |
| EvalRunResultCompareItem |
Metric comparison for a treatment against the baseline. |
| EvalRunResultComparison |
Comparison results for treatment runs against the baseline. |
| EvalRunResultSummary |
Summary statistics of a metric in an evaluation run. |
| EvaluationComparisonInsightRequest |
Evaluation Comparison Request. |
| EvaluationComparisonInsightResult |
Insights from the evaluation comparison. |
| EvaluationResultSample |
A sample from the evaluation result. |
| EvaluationRule |
Evaluation rule model. |
| EvaluationRuleAction |
Evaluation action model. Please note this is the abstract base class. The derived classes available for instantiation are: ContinuousEvaluationRuleAction and HumanEvaluationPreviewRuleAction. |
| EvaluationRuleFilter |
Evaluation filter model. |
| EvaluationRules |
The EvaluationRules sub-client. |
| EvaluationRunClusterInsightRequest |
Insights on set of Evaluation Results. |
| EvaluationRunClusterInsightResult |
Insights from the evaluation run cluster analysis. |
| EvaluationScheduleTask |
Evaluation task for the schedule. |
| EvaluationTarget |
Base class for targets with discriminator support. Please note this is the abstract base class. The derived classes available for instantiation are: AzureAIModelTarget and AzureAIAgentTarget. |
| EvaluationTaxonomies |
The EvaluationTaxonomies sub-client. |
| EvaluationTaxonomy |
Evaluation Taxonomy Definition. |
| EvaluationTaxonomyInput |
Input configuration for the evaluation taxonomy. Please note this is the abstract base class. The derived classes available for instantiation are: AgentTaxonomyInput. |
| EvaluatorDefinition |
The EvaluatorDefinition. |
| EvaluatorMetric |
Evaluator Metric. |
| EvaluatorVersion |
Evaluator Definition. |
| HourlyRecurrenceSchedule |
Hourly recurrence schedule. |
| HumanEvaluationPreviewRuleAction |
Evaluation rule action for human evaluation. |
| InsightCluster |
A cluster of analysis samples. |
| InsightModelConfiguration |
Configuration of the model used in the insight generation. |
| InsightRequest |
The request of the insights report. Please note this is the abstract base class. The derived classes available for instantiation are: EvaluationRunClusterInsightRequest, AgentClusterInsightRequest, and EvaluationComparisonInsightRequest. |
| InsightResult |
The result of the insights. Please note this is the abstract base class. The derived classes available for instantiation are: EvaluationComparisonInsightResult, EvaluationRunClusterInsightResult, and AgentClusterInsightResult. |
| InsightSample |
A sample from the analysis. Please note this is the abstract base class. The derived classes available for instantiation are: EvaluationResultSample. |
| InsightScheduleTask |
Insight task for the schedule. |
| InsightsMetadata |
Metadata about the insights. |
| InsightSummary |
Summary of the error cluster analysis. |
| ModelSamplingParams |
Represents a set of parameters used to control the sampling behavior of a language model during text generation. |
| MonthlyRecurrenceSchedule |
Monthly recurrence schedule. |
| OneTimeTrigger |
One-time trigger. |
| ProjectEvaluators |
The ProjectEvaluators sub-client. |
| ProjectInsight | |
| ProjectInsights |
The ProjectInsights sub-client. |
| ProjectsInsight |
The response body for cluster insights. |
| ProjectsSchedule |
The Schedules sub-client. |
| PromptBasedEvaluatorDefinition |
Prompt-based evaluator. |
| RecurrenceSchedule |
Recurrence schedule model. Please note this is the abstract base class. The derived classes available for instantiation are: HourlyRecurrenceSchedule, DailyRecurrenceSchedule, WeeklyRecurrenceSchedule, and MonthlyRecurrenceSchedule. |
| RecurrenceTrigger |
Recurrence based trigger. |
| RedTeam |
Red team details. |
| RedTeams |
The RedTeams sub-client. |
| ScheduleRun |
Schedule run model. |
| ScheduleTrigger |
Base model for Trigger of the schedule. Please note this is the abstract base class. The derived classes available for instantiation are: CronTrigger, RecurrenceTrigger, and OneTimeTrigger. |
| TargetConfig |
Abstract class for target configuration. Please note this is the abstract base class. The derived classes available for instantiation are: AzureOpenAIModelConfiguration. |
| TaxonomyCategory |
Taxonomy category definition. |
| TaxonomySubCategory |
Taxonomy sub-category definition. |
| WeeklyRecurrenceSchedule |
Weekly recurrence schedule. |
Structs
| Name | Description |
|---|---|
| AttackStrategy |
Strategies for attacks. |
| EvaluationRuleEventType |
Type of the evaluation rule event. |
| EvaluatorCategory |
The category of the evaluator. |
| EvaluatorDefinitionType |
The type of evaluator definition. |
| EvaluatorMetricDirection |
The direction of the metric indicating whether a higher value is better, a lower value is better, or neutral. |
| EvaluatorMetricType |
The type of the evaluator. |
| InsightType |
The request of the insights. |
| ListVersionsRequestType | |
| OperationStatus |
Enum describing allowed operation states. |
| RiskCategory |
Risk category for the attack objective. |
| ScheduleProvisioningStatus |
Schedule provisioning status. |
| ScheduleTaskType |
Type of the task. |
