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.

AgentInvocationsApiDispatchPayload

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

AgentInvocationsApiRoutineAction

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

AgentResponsesApiDispatchPayload

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

AgentResponsesApiRoutineAction

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

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.

AIProjectModels

The AIProjectModels sub-client.

AIProjectRoutines

The AIProjectRoutines sub-client.

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

Provides OpenAI client extensions for project client connections.

CustomRoutineTrigger

A custom event routine trigger.

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.

DataGenerationJobOutputOptions

Output options for data generation job.

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

DatasetEvaluatorGenerationJobSource

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

DatasetReference

Reference to a versioned Foundry Dataset.

DispatchRoutineResult

Identifiers returned after a routine dispatch is queued.

EmbeddingConfiguration

Embedding configuration class.

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.

GitHubIssueRoutineTrigger

A GitHub issue routine trigger.

InputFileContentParam

Input file.

InputTextContentParam

Input text.

ManagedAzureAISearchIndex

Managed Azure AI Search Index Definition.

MemoryDeletionResult

Response for deleting a memory item from a memory store.

ModelDeployment

Model Deployment Definition.

ModelDeploymentSku

Sku information.

ModelPendingUploadContent

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

ModelPendingUploadResult

Represents the response for a model pending upload request.

NoAuthenticationCredentials

Credentials that do not require authentication.

PendingUploadConfiguration

Represents a request for a pending upload.

PendingUploadResult

Represents the response for a pending upload request.

ProceduralMemoryItem

A memory item containing a procedure extracted from conversations.

ProjectSchedules

The Schedules sub-client.

ProjectsRoutine

A routine definition returned by the service.

ProjectsRoutineOptions

The options for creating routines.

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.

RoutineAction

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

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

A single routine run returned from the run history API.

RoutineTrigger

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

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

ScheduleRoutineTrigger

A recurring cron-based routine trigger.

SimpleQnADataGenerationJobOptions

The options for a data generation job with SimpleQnA type.

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

UpdateModelVersionOptions

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

Structs

Name Description
AIProjectDeploymentType
ConnectionType

The Type (or category) of the connection.

DataGenerationJobScenario

The supported scenarios for a data generation job.

EvaluationRuleActionType

Type of the evaluation action.

EvaluatorType

The type of the evaluator.

GitHubIssueEvent

Known GitHub issue events that can fire a routine.

PendingUploadType

The type of pending upload.

ProjectsJobStatus

Extensible status values shared by Foundry jobs.

RoutineActionKind

The discriminator values supported for routine actions.

RoutineAttemptSource

Known source paths that can produce a routine run.

RoutineRunPhase

Known lifecycle phases recorded for a routine run.

RoutineTriggerKind

The discriminator values supported for routine triggers.

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