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.

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.

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

Evaluation rule action for continuous evaluation.

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

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.

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

Dataset output for a data generation job.

DatasetDataGenerationJobSource(String, String, String)

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

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.

EmbeddingConfiguration(String, String)

Embedding configuration class.

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.

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.

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.

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, and RubricBasedEvaluatorDefinition.

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(String, IEnumerable<EvaluatorGenerationJobSource>, Nullable<EvaluatorCategory>, 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>, 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.

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.

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.

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.

MemoryStoreDefaultOptions(Boolean, String, Boolean)

Default memory store configurations.

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.

ModelSamplingParams(Single, Single, Int32, Int32)

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

NoAuthenticationCredentials()

Credentials that do not require authentication.

PendingUploadConfiguration(String, String)

Represents a request for a pending upload.

PendingUploadResult(AIProjectBlobReference, String, String)

Represents the response for a pending upload request.

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

The response body for cluster insights.

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.

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.

RubricBasedEvaluatorDefinition(BinaryData, BinaryData, IDictionary<String,EvaluatorMetric>, IEnumerable<RubricCriterion>)

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

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

A single rubric criterion — one measurable quality dimension in an evaluator's scoring blueprint.

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

Schedule run model.

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.

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, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Int32>)

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

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

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

Applies to