AzureAIProjectsModelFactory Class

Definition

A factory class for creating instances of the models for mocking.

public static class AzureAIProjectsModelFactory
type AzureAIProjectsModelFactory = class
Public Class AzureAIProjectsModelFactory
Inheritance
AzureAIProjectsModelFactory

Methods

Name Description
AgentClusterInsightRequest(String, InsightModelConfiguration)

Insights on set of Agent Evaluation Results.

AgentClusterInsightResult(ClusterInsightResult)

Insights from the agent cluster analysis.

AgentDataGenerationJobSource(String, String, String)

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

AgentEvaluatorGenerationJobSource(String, String, String)

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

AgenticIdentityPreviewCredentials()

Agentic identity credential definition.

AgentInvocationsApiDispatchPayload(BinaryData)

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

AgentInvocationsApiRoutineAction(String, String, BinaryData, String)

Dispatches a routine through the raw invocations API. Exactly one of agent_name or agent_endpoint_id must be provided.

AgentResponsesApiDispatchPayload(BinaryData)

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

AgentResponsesApiRoutineAction(String, String, BinaryData, String)

Dispatches a routine through the responses API. Exactly one of agent_name or agent_endpoint_id must be provided.

AgentTaxonomyInput(EvaluationTarget, IEnumerable<RiskCategory>)

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

AIProjectBlobReference(Uri, String, BlobReferenceSasCredential)

Blob reference details.

AIProjectConnection(String, String, ConnectionType, String, Boolean, AIProjectConnectionBaseCredential, IReadOnlyDictionary<String,String>)

Response from the list and get connections operations.

AIProjectConnectionApiKeyCredential(String)

API Key Credential definition.

AIProjectConnectionBaseCredential(String)

A base class for connection credentials Please note this is the abstract base class. The derived classes available for instantiation are: AIProjectConnectionApiKeyCredential, AIProjectConnectionEntraIdCredential, AIProjectConnectionCustomCredential, AIProjectConnectionSasCredential, NoAuthenticationCredentials, and AgenticIdentityPreviewCredentials.

AIProjectConnectionCustomCredential(IReadOnlyDictionary<String,String>)

Custom credential definition.

AIProjectConnectionEntraIdCredential()

Entra ID credential definition.

AIProjectConnectionSasCredential(String)

Shared Access Signature (SAS) credential definition.

AIProjectCosmosDBIndex(String, String, String, String, IDictionary<String, String>, String, String, String, EmbeddingConfiguration, AIProjectIndexFieldMapping)

CosmosDB Vector Store Index Definition.

AIProjectDataset(Uri, String, Nullable<Boolean>, String, String, String, String, String, IDictionary<String,String>)

DatasetVersion Definition Please note this is the abstract base class. The derived classes available for instantiation are: FileDataset and FolderDataset.

AIProjectDeployment(String, String)

Model Deployment Definition Please note this is the abstract base class. The derived classes available for instantiation are: ModelDeployment.

AIProjectIndex(String, String, String, String, String, IDictionary<String,String>)

Index resource Definition Please note this is the abstract base class. The derived classes available for instantiation are: AzureAISearchIndex, ManagedAzureAISearchIndex, and AIProjectCosmosDBIndex.

AIProjectIndexFieldMapping(IEnumerable<String>, String, String, String, IEnumerable<String>, IEnumerable<String>)

Field mapping configuration class.

AzureAIAgentTarget(String, String, IEnumerable<ToolDescription>)

Represents a target specifying an Azure AI agent.

AzureAIModelTarget(String, ModelSamplingParams)

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

AzureAISearchIndex(String, String, String, String, IDictionary<String,String>, String, String, AIProjectIndexFieldMapping)

Azure AI Search Index Definition.

AzureOpenAIModelConfiguration(String)

Azure OpenAI model configuration. The API version would be selected by the service for querying the model.

BlobReferenceSasCredential(Uri)

SAS Credential definition.

ChartCoordinate(Int32, Int32, Int32)

Coordinates for the analysis chart.

ChatSummaryMemoryItem(String, DateTimeOffset, String, String)

A memory item containing a summary extracted from conversations.

ClusterInsightResult(InsightSummary, IEnumerable<InsightCluster>, IDictionary<String,ChartCoordinate>)

Insights from the cluster analysis.

ClusterTokenUsage(Int32, Int32, Int32)

Token usage for cluster analysis.

CodeBasedEvaluatorDefinition(BinaryData, BinaryData, IDictionary<String,EvaluatorMetric>, String, String, String, Uri)

Code-based evaluator definition using python code.

ContinuousEvaluationRuleAction(String, Nullable<Int32>, Nullable<Double>)

Evaluation rule action for continuous evaluation.

CronTrigger(String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>)

Cron based trigger.

CustomRoutineTrigger(String, String, IDictionary<String,BinaryData>)

A custom event routine trigger.

DailyRecurrenceSchedule(IEnumerable<Int32>)

Daily recurrence schedule.

DataGenerationJobInputs(String, IEnumerable<DataGenerationJobSource>, DataGenerationJobOptions, DataGenerationJobScenario, DataGenerationJobOutputOptions)

Caller-supplied inputs for a data generation job.

DataGenerationJobOptions(String, Int32, Nullable<Single>, DataGenerationModelOptions)

Options for managing data generation jobs. Please note this is the abstract base class. The derived classes available for instantiation are: SimpleQnADataGenerationJobOptions, TracesDataGenerationJobOptions, and ToolUseFineTuningDataGenerationJobOptions.

DataGenerationJobOutput(String)

Output information for a data generation job. Please note this is the abstract base class. The derived classes available for instantiation are: FileDataGenerationJobOutput and DatasetDataGenerationJobOutput.

DataGenerationJobOutputOptions(String, String, IDictionary<String,String>)

Output options for data generation job.

DataGenerationJobResult(IEnumerable<DataGenerationJobOutput>, Int32, DataGenerationTokenUsage)

Result produced by a successful data generation job.

DataGenerationJobSource(String, String)

The base source model for data generation jobs. Please note this is the abstract base class. The derived classes available for instantiation are: PromptDataGenerationJobSource, AgentDataGenerationJobSource, TracesDataGenerationJobSource, and FileDataGenerationJobSource.

DataGenerationModelOptions(String)

LLM model options for data generation jobs.

DataGenerationTokenUsage(Int64, Int64, Int64)

Token usage information for a data generation job.

DatasetCredential(AIProjectBlobReference)

Represents a reference to a blob for consumption.

DatasetDataGenerationJobOutput(String, String, String, String, IReadOnlyDictionary<String,String>)

Dataset output for a data generation job.

DatasetEvaluatorGenerationJobSource(String, String, String)

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

DatasetReference(String, String)

Reference to a versioned Foundry Dataset.

DeleteMemoryStoreResponse(String, Boolean)

The DeleteMemoryStoreResponse.

DispatchRoutineResult(String, String, String)

Identifiers returned after a routine dispatch is queued.

EmbeddingConfiguration(String, String)

Embedding configuration class.

EndpointBasedEvaluatorDefinition(BinaryData, BinaryData, IDictionary<String,EvaluatorMetric>, String)

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.

EvalResult(String, String, Single, Boolean)

Result of the evaluation.

EvalRunResultCompareItem(String, EvalRunResultSummary, Single, Single, TreatmentEffectType)

Metric comparison for a treatment against the baseline.

EvalRunResultComparison(String, String, String, EvalRunResultSummary, IEnumerable<EvalRunResultCompareItem>)

Comparison results for treatment runs against the baseline.

EvalRunResultSummary(String, Int32, Single, Single)

Summary statistics of a metric in an evaluation run.

EvaluationComparisonInsightRequest(String, String, IEnumerable<String>)

Evaluation Comparison Request.

EvaluationComparisonInsightResult(IEnumerable<EvalRunResultComparison>, String)

Insights from the evaluation comparison.

EvaluationCredentialContent(Uri)

Request body for getting evaluator credentials.

EvaluationResultSample(String, IDictionary<String,BinaryData>, IDictionary<String,BinaryData>, EvalResult)

A sample from the evaluation result.

EvaluationRule(String, String, String, EvaluationRuleAction, EvaluationRuleFilter, EvaluationRuleEventType, Boolean, IReadOnlyDictionary<String, String>)

Evaluation rule model.

EvaluationRuleAction(String)

Evaluation action model. Please note this is the abstract base class. The derived classes available for instantiation are: ContinuousEvaluationRuleAction and HumanEvaluationPreviewRuleAction.

EvaluationRuleFilter(String)

Evaluation filter model.

EvaluationRunClusterInsightRequest(String, IEnumerable<String>, InsightModelConfiguration)

Insights on set of Evaluation Results.

EvaluationRunClusterInsightResult(ClusterInsightResult)

Insights from the evaluation run cluster analysis.

EvaluationScheduleTask(IDictionary<String,String>, String, BinaryData)

Evaluation task for the schedule.

EvaluationsDimension(String, String, Int32, Nullable<Boolean>)

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

EvaluationTarget(String)

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.

EvaluationTaxonomy(String, String, String, String, IDictionary<String, String>, EvaluationTaxonomyInput, IEnumerable<TaxonomyCategory>, IDictionary<String,String>)

Evaluation Taxonomy Definition.

EvaluationTaxonomyInput(String)

Input configuration for the evaluation taxonomy. Please note this is the abstract base class. The derived classes available for instantiation are: AgentTaxonomyInput.

EvaluatorDefinition(String, BinaryData, BinaryData, IDictionary<String,EvaluatorMetric>)

Base evaluator configuration with discriminator Please note this is the abstract base class. The derived classes available for instantiation are: CodeBasedEvaluatorDefinition, PromptBasedEvaluatorDefinition, RubricBasedEvaluatorDefinition, and EndpointBasedEvaluatorDefinition.

EvaluatorGenerationArtifacts(DatasetReference, IEnumerable<String>)

Service-managed provenance artifacts produced by an evaluator generation job. Present only on EvaluatorVersion resources created via the generation pipeline. The combined-JSONL Foundry Dataset is read-only and resolves to a versioned dataset in a service-reserved namespace.

EvaluatorGenerationInputs(IEnumerable<EvaluatorGenerationJobSource>, String, String, String, String)

Caller-supplied inputs for an evaluator generation job.

EvaluatorGenerationJobSource(String)

The base source model for evaluator generation jobs. Polymorphic over type. Please note this is the abstract base class. The derived classes available for instantiation are: PromptEvaluatorGenerationJobSource, AgentEvaluatorGenerationJobSource, TracesEvaluatorGenerationJobSource, and DatasetEvaluatorGenerationJobSource.

EvaluatorGenerationTokenUsage(Int64, Int64, Int64)

Token consumption summary for an evaluator generation job. Populated when the job reaches a terminal state.

EvaluatorMetric(Nullable<EvaluatorMetricType>, Nullable<EvaluatorMetricDirection>, Nullable<Single>, Nullable<Single>, Nullable<Single>, Nullable<Boolean>)

Evaluator Metric.

EvaluatorVersion(String, IDictionary<String,String>, EvaluatorType, IEnumerable<EvaluatorCategory>, IEnumerable<ProjectsEvaluationLevel>, EvaluatorDefinition, EvaluatorGenerationArtifacts, String, String, String, String, String, String, String, IDictionary<String,String>)

Evaluator Definition.

FileDataGenerationJobOutput(String, String)

Azure OpenAI file output for a data generation job.

FileDataGenerationJobSource(String, String)

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

FileDataset(Uri, Nullable<Boolean>, String, String, String, String, String, IDictionary<String,String>)

FileDatasetVersion Definition.

FolderDataset(Uri, Nullable<Boolean>, String, String, String, String, String, IDictionary<String,String>)

FileDatasetVersion Definition.

GitHubIssueRoutineTrigger(String, String, String, GitHubIssueEvent)

A GitHub issue routine trigger.

HourlyRecurrenceSchedule()

Hourly recurrence schedule.

HumanEvaluationPreviewRuleAction(String)

Evaluation rule action for human evaluation.

InputFileContentParam(String, String, String, Uri)

Input file.

InputTextContentParam(String)

Input text.

InsightCluster(String, String, String, String, String, Int32, IEnumerable<InsightCluster>, IEnumerable<InsightSample>)

A cluster of analysis samples.

InsightModelConfiguration(String)

Configuration of the model used in the insight generation.

InsightRequest(String)

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(String)

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(String, String, IDictionary<String,BinaryData>, IDictionary<String,BinaryData>)

A sample from the analysis. Please note this is the abstract base class. The derived classes available for instantiation are: EvaluationResultSample.

InsightScheduleTask(IDictionary<String,String>, ProjectsInsight)

Insight task for the schedule.

InsightsMetadata(DateTimeOffset, Nullable<DateTimeOffset>)

Metadata about the insights.

InsightSummary(Int32, Int32, Int32, String, ClusterTokenUsage)

Summary of the error cluster analysis.

ManagedAzureAISearchIndex(String, String, String, String, IDictionary<String,String>, String)

Managed Azure AI Search Index Definition.

MemoryDeletionResult(String, Boolean)

Response for deleting a memory item from a memory store.

MemoryItem(String, DateTimeOffset, String, String, String)

A single memory item stored in the memory store, containing content and metadata. Please note this is the abstract base class. The derived classes available for instantiation are: UserProfileMemoryItem, ChatSummaryMemoryItem, and ProceduralMemoryItem.

MemoryOperation(MemoryOperationKind, MemoryItem)

Represents a single memory operation (create, update, or delete) performed on a memory item.

MemorySearchItem(MemoryItem)

A retrieved memory item from memory search.

MemorySearchResultOptions(Nullable<Int32>)

Memory search options.

MemoryStore(String, DateTimeOffset, DateTimeOffset, String, String, IDictionary<String,String>, MemoryStoreDefinition)

A memory store that can store and retrieve user memories.

MemoryStoreDefaultDefinition(String, String, MemoryStoreDefaultOptions)

Default memory store implementation.

MemoryStoreDefaultOptions(Boolean, String, Boolean, Nullable<Boolean>, Nullable<TimeSpan>)

Default memory store configurations.

MemoryStoreDefinition(String)

Base definition for memory store configurations. Please note this is the abstract base class. The derived classes available for instantiation are: MemoryStoreDefaultDefinition.

MemoryStoreDeleteScopeResponse(String, String, Boolean)

Response for deleting memories from a scope.

MemoryStoreOperationUsage(Int32, Int64, ResponseUsageInputTokensDetails, Int64, ResponseUsageOutputTokensDetails, Int64)

Usage statistics of a memory store operation.

MemoryStoreSearchResponse(String, IEnumerable<MemorySearchItem>, MemoryStoreOperationUsage)

Memory search response.

MemoryUpdateResultDetails(IEnumerable<MemoryOperation>, MemoryStoreOperationUsage)

Memory update result.

ModelDeployment(String, String, String, String, IReadOnlyDictionary<String,String>, ModelDeploymentSku, String)

Model Deployment Definition.

ModelDeploymentSku(Int64, String, String, String, String)

Sku information.

ModelPendingUploadContent(String, String)

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

ModelPendingUploadResult(AIProjectBlobReference, String, String)

Represents the response for a model pending upload request.

ModelSamplingParams(Single, Single, Int32, Int32)

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

MonthlyRecurrenceSchedule(IEnumerable<Int32>)

Monthly recurrence schedule.

NoAuthenticationCredentials()

Credentials that do not require authentication.

OneTimeTrigger(DateTimeOffset, String)

One-time trigger.

PendingUploadConfiguration(String, String)

Represents a request for a pending upload.

PendingUploadResult(AIProjectBlobReference, String, String)

Represents the response for a pending upload request.

ProceduralMemoryItem(String, DateTimeOffset, String, String)

A memory item containing a procedure extracted from conversations.

ProjectsInsight(String, InsightsMetadata, OperationStatus, String, InsightRequest, InsightResult)

The response body for cluster insights.

ProjectsRoutine(String, String, Boolean, IDictionary<String,RoutineTrigger>, RoutineAction, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>)

A routine definition returned by the service.

ProjectsSchedule(String, String, String, Boolean, Nullable<ScheduleProvisioningStatus>, ScheduleTrigger, ProjectsScheduleTask, IDictionary<String,String>, IDictionary<String,String>, IReadOnlyDictionary<String,String>)

Schedule model.

ProjectsScheduleTask(String, IDictionary<String,String>)

Schedule task model. Please note this is the abstract base class. The derived classes available for instantiation are: EvaluationScheduleTask and InsightScheduleTask.

PromptBasedEvaluatorDefinition(BinaryData, BinaryData, IDictionary<String,EvaluatorMetric>, String)

Prompt-based evaluator.

PromptDataGenerationJobSource(String, String)

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

PromptEvaluatorGenerationJobSource(String, String)

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

RecurrenceSchedule(String)

Recurrence schedule model. Please note this is the abstract base class. The derived classes available for instantiation are: HourlyRecurrenceSchedule, DailyRecurrenceSchedule, WeeklyRecurrenceSchedule, and MonthlyRecurrenceSchedule.

RecurrenceTrigger(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, Int32, RecurrenceSchedule)

Recurrence based trigger.

RedTeam(String, String, Nullable<Int32>, IEnumerable<AttackStrategy>, Nullable<Boolean>, IEnumerable<RiskCategory>, String, IDictionary<String, String>, IDictionary<String,String>, String, TargetConfig)

Red team details.

ResponseUsageInputTokensDetails(Int64)

The ResponseUsageInputTokensDetails.

ResponseUsageOutputTokensDetails(Int64)

The ResponseUsageOutputTokensDetails.

RoutineAction(String)

Base model for a routine action. Please note this is the abstract base class. The derived classes available for instantiation are: AgentResponsesApiRoutineAction and AgentInvocationsApiRoutineAction.

RoutineDispatchPayload(String)

Base model for a manual dispatch payload. Please note this is the abstract base class. The derived classes available for instantiation are: AgentResponsesApiDispatchPayload and AgentInvocationsApiDispatchPayload.

RoutineRun(String, BinaryData, Nullable<RoutineRunPhase>, Nullable<RoutineTriggerKind>, String, IDictionary<String,BinaryData>, Nullable<RoutineAttemptSource>, Nullable<RoutineActionKind>, String, String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, String, String, String, Nullable<Int32>, String, String)

A single routine run returned from the run history API.

RoutineTrigger(String)

Base model for a routine trigger. Please note this is the abstract base class. The derived classes available for instantiation are: ScheduleRoutineTrigger, TimerRoutineTrigger, GitHubIssueRoutineTrigger, and CustomRoutineTrigger.

RubricBasedEvaluatorDefinition(BinaryData, BinaryData, IDictionary<String,EvaluatorMetric>, IEnumerable<EvaluationsDimension>, Nullable<Single>)

Rubric-based evaluator definition — stores dimensions produced by the generate API. Used for both quality and safety evaluators.

ScheduleRoutineTrigger(String, String)

A recurring cron-based routine trigger.

ScheduleRun(String, String, Boolean, Nullable<DateTimeOffset>, String, IReadOnlyDictionary<String,String>)

Schedule run model.

ScheduleTrigger(String)

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.

SimpleQnADataGenerationJobOptions(Int32, Nullable<Single>, DataGenerationModelOptions, IEnumerable<SimpleQnAFineTuningQuestionType>)

The options for a data generation job with SimpleQnA type.

TargetConfig(String)

Abstract class for target configuration. Please note this is the abstract base class. The derived classes available for instantiation are: AzureOpenAIModelConfiguration.

TaxonomyCategory(String, String, String, RiskCategory, IEnumerable<TaxonomySubCategory>, IDictionary<String,String>)

Taxonomy category definition.

TaxonomySubCategory(String, String, String, Boolean, IDictionary<String,String>)

Taxonomy sub-category definition.

TimerRoutineTrigger(Nullable<DateTimeOffset>)

A one-shot timer routine trigger.

ToolDescription(String, String)

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

ToolUseFineTuningDataGenerationJobOptions(Int32, Nullable<Single>, DataGenerationModelOptions)

The options for a data generation job with ToolUse type. Used only for fine-tuning scenarios.

TracesDataGenerationJobOptions(Int32, Nullable<Single>, DataGenerationModelOptions)

The options for a data generation job with Traces type.

TracesDataGenerationJobSource(String, String, String, String, DateTimeOffset, Nullable<DateTimeOffset>)

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

TracesEvaluatorGenerationJobSource(String, String, String, String, DateTimeOffset, Nullable<DateTimeOffset>)

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

UpdateModelVersionOptions(String, IDictionary<String,String>)

Request body for updating a model version. Only description and tags can be modified.

UserProfileMemoryItem(String, DateTimeOffset, String, String)

A memory item specifically containing user profile information extracted from conversations, such as preferences, interests, and personal details.

WeeklyRecurrenceSchedule(IEnumerable<DayOfWeek>)

Weekly recurrence schedule.

Applies to