com.azure.ai.projects.models

Package containing the data models for AIProjects.

Classes

AIProjectIndex

Index resource Definition.

AgentClusterInsightRequest

Insights on set of Agent Evaluation Results.

AgentClusterInsightResult

Insights from the agent cluster analysis.

AgentDataGenerationJobSource

Agent source for data generation jobs — references an agent to fetch instructions and metadata from.

AgentEvaluatorGenerationJobSource

Agent source for evaluator generation jobs — references an agent to fetch instructions and metadata from.

AgentTaxonomyInput

Input configuration for the evaluation taxonomy when the input type is agent.

AgenticIdentityPreviewCredential

Agentic identity credential definition.

ApiError

The ApiError model.

ApiKeyCredential

API Key Credential definition.

ArtifactProfile

Artifact profile of the model.

AttackStrategy

Strategies for attacks.

AzureAIAgentTarget

Represents a target specifying an Azure AI agent.

AzureAIModelTarget

Represents a target specifying an Azure AI model for operations requiring model selection.

AzureAISearchIndex

Azure AI Search Index Definition.

AzureOpenAIModelConfiguration

Azure OpenAI model configuration.

BaseCredential

A base class for connection credentials.

BlobReference

Blob reference details.

BlobReferenceSasCredential

SAS Credential definition.

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.

Connection

Response from the list and get connections operations.

ConnectionType

The Type (or category) of the connection.

ContinuousEvaluationRuleAction

Evaluation rule action for continuous evaluation.

CosmosDBIndex

CosmosDB Vector Store Index Definition.

CreateAsyncResponse

The CreateAsyncResponse model.

CreateSkillVersionFromFilesBody

Multipart request body for creating a skill version from files.

CredentialType

The credential type used by the connection.

CronTrigger

Cron based trigger.

CustomCredential

Custom credential definition.

CustomRoutineTrigger

A custom event routine trigger.

DailyRecurrenceSchedule

Daily recurrence schedule.

DataGenerationJob

Data Generation Job resource.

DataGenerationJobInputs

Caller-supplied inputs for a data generation job.

DataGenerationJobOptions

Options for managing data generation jobs.

DataGenerationJobOutput

Output information for a data generation job.

DataGenerationJobOutputOptions

Output options for data generation job.

DataGenerationJobOutputType

The supported output file types for a data generation job.

DataGenerationJobResult

Result produced by a successful data generation job.

DataGenerationJobScenario

The supported scenarios for a data generation job.

DataGenerationJobSource

The base source model for data generation jobs.

DataGenerationJobSourceType

The supported source types for data generation jobs.

DataGenerationJobType

The supported data generation job types.

DataGenerationModelOptions

LLM model options for data generation jobs.

DataGenerationTokenUsage

Token usage information for a data generation job.

DatasetCredential

Represents a reference to a blob for consumption.

DatasetDataGenerationJobOutput

Dataset output for a data generation job.

DatasetEvaluatorGenerationJobSource

Dataset source for evaluator generation jobs — reference to a dataset.

DatasetReference

Reference to a versioned Foundry Dataset.

DatasetType

Enum to determine the type of data.

DatasetVersion

DatasetVersion Definition.

Deployment

Model Deployment Definition.

DeploymentType

Defines values for DeploymentType.

Dimension

A single dimension — one independent, measurable quality dimension within a rubric evaluator's scoring blueprint.

DispatchRoutineResult

Identifiers returned after a routine dispatch is queued.

EmbeddingConfiguration

Embedding configuration class.

EndpointBasedEvaluatorDefinition

Endpoint-based evaluator definition.

EntraIdCredential

Entra ID credential definition.

EvaluationComparisonInsightRequest

Evaluation Comparison Request.

EvaluationComparisonInsightResult

Insights from the evaluation comparison.

EvaluationLevel

The level at which evaluation is performed.

EvaluationResult

Result of the evaluation.

EvaluationResultSample

A sample from the evaluation result.

EvaluationRule

Evaluation rule model.

EvaluationRuleAction

Evaluation action model.

EvaluationRuleActionType

Type of the evaluation action.

EvaluationRuleEventType

Type of the evaluation rule event.

EvaluationRuleFilter

Evaluation filter model.

EvaluationRunClusterInsightRequest

Insights on set of Evaluation Results.

EvaluationRunClusterInsightResult

Insights from the evaluation run cluster analysis.

EvaluationRunResultCompareItem

Metric comparison for a treatment against the baseline.

EvaluationRunResultComparison

Comparison results for treatment runs against the baseline.

EvaluationRunResultSummary

Summary statistics of a metric in an evaluation run.

EvaluationScheduleTask

Evaluation task for the schedule.

EvaluationTaxonomy

Evaluation Taxonomy Definition.

EvaluationTaxonomyInput

Input configuration for the evaluation taxonomy.

EvaluationTaxonomyInputType

Type of the evaluation taxonomy input.

EvaluatorCategory

The category of the evaluator.

EvaluatorCredentialInput

Request body for getting evaluator credentials.

EvaluatorDefinition

Base evaluator configuration with discriminator.

EvaluatorDefinitionType

The type of evaluator definition.

EvaluatorGenerationArtifacts

Service-managed provenance artifacts produced by an evaluator generation job.

EvaluatorGenerationInputs

Caller-supplied inputs for an evaluator generation job.

EvaluatorGenerationJob

Evaluator Generation Job resource — a long-running job that generates rubric-based evaluator definitions from source materials.

EvaluatorGenerationJobSource

The base source model for evaluator generation jobs.

EvaluatorGenerationJobSourceType

The supported source types for evaluator generation jobs.

EvaluatorGenerationTokenUsage

Token consumption summary for an evaluator generation job.

EvaluatorMetric

Evaluator Metric.

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.

EvaluatorType

The type of the evaluator.

EvaluatorVersion

Evaluator Definition.

FieldMapping

Field mapping configuration class.

FileDataGenerationJobOutput

Azure OpenAI file output for a data generation job.

FileDataGenerationJobSource

File source for data generation jobs — Azure OpenAI file input.

FileDatasetVersion

FileDatasetVersion Definition.

FolderDatasetVersion

FileDatasetVersion Definition.

FoundryModelArtifactProfileCategory

The artifact profile category.

FoundryModelArtifactProfileSignal

Signals detected in the model artifact.

FoundryModelSourceType

The source type of the model.

FoundryModelWarning

A warning associated with a model.

FoundryModelWarningCode

Warning code for model artifacts.

FoundryModelWeightType

The weight type of the model.

GitHubIssueEvent

Known GitHub issue events that can fire a routine.

GitHubIssueRoutineTrigger

A GitHub issue routine trigger.

GraderAzureAIEvaluator

Grader Azure AI Evaluator definition for foundry evaluators.

HourlyRecurrenceSchedule

Hourly recurrence schedule.

HumanEvaluationPreviewRuleAction

Evaluation rule action for human evaluation.

IndexType

Defines values for IndexType.

Insight

The response body for cluster insights.

InsightCluster

A cluster of analysis samples.

InsightModelConfiguration

Configuration of the model used in the insight generation.

InsightRequest

The request of the insights report.

InsightResult

The result of the insights.

InsightSample

A sample from the analysis.

InsightScheduleTask

Insight task for the schedule.

InsightSummary

Summary of the error cluster analysis.

InsightType

The request of the insights.

InsightsMetadata

Metadata about the insights.

InvokeAgentInvocationsApiDispatchPayload

A manual payload used to test an invocations API routine dispatch.

InvokeAgentInvocationsApiRoutineAction

Dispatches a routine through the raw invocations API.

InvokeAgentResponsesApiDispatchPayload

A manual payload used to test a responses API routine dispatch.

InvokeAgentResponsesApiRoutineAction

Dispatches a routine through the responses API.

JobStatus

Extensible status values shared by Foundry jobs.

ListVersionsRequestType

Defines values for ListVersionsRequestType.

LoraConfig

Adapter-specific metadata for LoRA models.

ManagedAzureAISearchIndex

Managed Azure AI Search Index Definition.

ModelCredentialInput

Request to fetch credentials for a model asset.

ModelDeployment

Model Deployment Definition.

ModelDeploymentSku

Sku information.

ModelPendingUploadInput

Represents a request for a pending upload of a model version.

ModelPendingUploadResult

Represents the response for a model pending upload request.

ModelSamplingParams

Represents a set of parameters used to control the sampling behavior of a language model during text generation.

ModelSourceData

Source information for the model.

ModelVersion

Model Version Definition.

MonthlyRecurrenceSchedule

Monthly recurrence schedule.

NoAuthenticationCredential

Credentials that do not require authentication.

OneTimeTrigger

One-time trigger.

OperationStatus

Enum describing allowed operation states.

PendingUploadRequest

Represents a request for a pending upload.

PendingUploadResponse

Represents the response for a pending upload request.

PendingUploadType

The type of pending upload.

PromptBasedEvaluatorDefinition

Prompt-based evaluator.

PromptDataGenerationJobSource

Prompt source for data generation jobs — inline text provided by the user.

PromptEvaluatorGenerationJobSource

Prompt source for evaluator generation jobs — inline text provided by the user.

RecurrenceSchedule

Recurrence schedule model.

RecurrenceTrigger

Recurrence based trigger.

RecurrenceType

Recurrence type.

RedTeam

Red team details.

RiskCategory

Risk category for the attack objective.

Routine

A routine definition returned by the service.

RoutineAction

Base model for a routine action.

RoutineActionType

The discriminator values supported for routine actions.

RoutineAttemptSource

Known source paths that can produce a routine run.

RoutineDispatchPayload

Base model for a manual dispatch payload.

RoutineDispatchPayloadType

The discriminator values supported for manual routine dispatch payloads.

RoutineRun

A single routine run returned from the run history API.

RoutineRunPhase

Known lifecycle phases recorded for a routine run.

RoutineTrigger

Base model for a routine trigger.

RoutineTriggerType

The discriminator values supported for routine triggers.

RubricBasedEvaluatorDefinition

Rubric-based evaluator definition — stores dimensions produced by the generate API.

SampleType

The type of sample used in the analysis.

SasCredential

Shared Access Signature (SAS) credential definition.

Schedule

Schedule model.

ScheduleProvisioningStatus

Schedule provisioning status.

ScheduleRoutineTrigger

A recurring cron-based routine trigger.

ScheduleRun

Schedule run model.

ScheduleTask

Schedule task model.

ScheduleTaskType

Type of the task.

SimpleQnADataGenerationJobOptions

The options for a data generation job with SimpleQnA type.

SimpleQnAFineTuningQuestionType

The supported question types for SimpleQnA data generation jobs used for fine-tuning scenarios.

SkillDetails

A skill resource.

SkillFileDetails

A file in an HTTP request, response, or multipart payload.

SkillInlineContent

Inline content for defining a simple skill without uploading files.

SkillVersion

A specific version of a skill.

Target

Base class for targets with discriminator support.

TargetConfig

Abstract class for target configuration.

TaxonomyCategory

Taxonomy category definition.

TaxonomySubCategory

Taxonomy sub-category definition.

TestingCriterionAzureAIEvaluator

AzureAIEvaluatorGrader An Azure AI Evaluator grader used as testing criterion in evaluations.

TimerRoutineTrigger

A one-shot timer routine trigger.

ToolDescription

Description of a tool that can be used by an agent.

ToolUseFineTuningDataGenerationJobOptions

The options for a data generation job with ToolUse type.

TracesDataGenerationJobOptions

The options for a data generation job with Traces type.

TracesDataGenerationJobSource

Traces source for data generation jobs — conversation traces from Application Insights.

TracesEvaluatorGenerationJobSource

Traces source for evaluator generation jobs — conversation traces from Application Insights.

TreatmentEffectType

Treatment Effect Type.

Trigger

Base model for Trigger of the schedule.

TriggerType

Type of the trigger.

UpdateModelVersionInput

Request body for updating a model version.

WeeklyRecurrenceSchedule

Weekly recurrence schedule.