Azure.AI.Projects Namespace

Classes

Name Description
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.

AgenticIdentityPreviewCredentials

Agentic identity credential definition.

AIProjectBlobReference

Blob reference details.

AIProjectClient

The AzureAI service client.

AIProjectClientOptions

Client options for AIProjectClient.

AIProjectClientSettings

Represents the settings used to configure a AIProjectClient that can be loaded from an IConfigurationSection.

AIProjectConnection

Response from the list and get connections operations.

AIProjectConnectionApiKeyCredential

API Key Credential definition.

AIProjectConnectionBaseCredential

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

Custom credential definition.

AIProjectConnectionEntraIdCredential

Entra ID credential definition.

AIProjectConnectionSasCredential

Shared Access Signature (SAS) credential definition.

AIProjectConnectionsOperations

The AIProjectConnectionsOperations sub-client.

AIProjectCosmosDBIndex

CosmosDB Vector Store Index Definition.

AIProjectDataset

AIProjectDataset Definition Please note AIProjectDataset is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include FileDataset and FolderDataset.

AIProjectDatasetsOperations

The AIProjectDatasetsOperations sub-client.

AIProjectDeployment

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

AIProjectDeploymentsOperations

The AIProjectDeploymentsOperations sub-client.

AIProjectIndex

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

AIProjectIndexesOperations

The AIProjectIndexesOperations sub-client.

AIProjectIndexFieldMapping

Field mapping configuration class.

AIProjectTelemetry

Provides telemetry-related operations for the project.

AzureAIProjectsContext

Context class which will be filled in by the System.ClientModel.SourceGeneration. For more information https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/System.ClientModel/src/docs/ModelReaderWriterContext.md

AzureAIProjectsModelFactory

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

AzureAISearchIndex

Azure AI Search Index Definition.

BlobReferenceSasCredential

SAS Credential definition.

ClientConnectionProviderExtensions
DataGenerationJob

Data Generation Job resource.

DataGenerationJobInputs

Caller-supplied inputs for a data generation job.

DataGenerationJobOptions

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

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

Result produced by a successful data generation job.

DataGenerationJobs

The DataGenerationJobs sub-client.

DataGenerationJobSource

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

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.

DatasetDataGenerationJobSource

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

DatasetEvaluatorGenerationJobSource

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

DatasetReference

Reference to a versioned Foundry Dataset.

EmbeddingConfiguration

Embedding configuration class.

EvaluatorGenerationArtifacts

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

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. On success, the result is the persisted EvaluatorVersion.

EvaluatorGenerationJobs

The EvaluatorGenerationJobs sub-client.

EvaluatorGenerationJobSource

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

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

FileDataGenerationJobOutput

Azure OpenAI file output for a data generation job.

FileDataGenerationJobSource

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

FileDataset

FileDatasetVersion Definition.

FolderDataset

FileDatasetVersion Definition.

InputFileContentParam

Input file.

InputTextContentParam

Input text.

ManagedAzureAISearchIndex

Managed Azure AI Search Index Definition.

ModelDeployment

Model Deployment Definition.

ModelDeploymentSku

Sku information.

NoAuthenticationCredentials

Credentials that do not require authentication.

PendingUploadConfiguration

Represents a request for a pending upload.

PendingUploadResult

Represents the response for a pending upload request.

ProjectSchedules

The Schedules sub-client.

ProjectsScheduleTask

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

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.

ResponseUsageInputTokensDetails

The ResponseUsageInputTokensDetails.

ResponseUsageOutputTokensDetails

The ResponseUsageOutputTokensDetails.

RubricBasedEvaluatorDefinition

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

RubricCriterion

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

SimpleQnADataGenerationJobOptions

The options for a data generation job with SimpleQnA type.

ToolDescription

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

ToolUseFineTuningDataGenerationJobOptions

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

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.

Structs

Name Description
AIProjectDeploymentType
ConnectionType

The Type (or category) of the connection.

DataGenerationJobKind

The supported data generation job types.

DataGenerationJobScenario

The supported scenarios for a data generation job.

EvaluationRuleActionType

Type of the evaluation action.

EvaluatorType

The type of the evaluator.

JobStatus

Extensible status values shared by Foundry jobs.

PendingUploadType

The type of pending upload.

SimpleQnAFineTuningQuestionType

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

TreatmentEffectType

Treatment Effect Type.

Enums

Name Description
AIProjectClientOptions.ServiceVersion

The version of the service to use.

FoundryFeaturesOptInKeys