Azure.AI.Projects Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| Name | Description |
|---|---|
| AgentClusterInsightResult |
Insights from the agent cluster analysis. |
| AgentClusterInsightsRequest |
Insights on set of Agent Evaluation Results. |
| AgenticIdentityCredentials |
Agentic identity credential definition. |
| AgentManifestOptions |
The AgentManifestOptions. |
| AgentTaxonomyInput |
Input configuration for the evaluation taxonomy when the input type is agent. |
| AgentVersionCreationOptions |
The AgentVersionCreationOptions. |
| AIProjectAgentsOperations |
The AIProjectAgentsOperations sub-client. |
| AIProjectBlobReference |
Blob reference details. |
| AIProjectClient |
The AzureAI service client. |
| AIProjectClientOptions |
Client options for AIProjectClient. |
| 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 AgenticIdentityCredentials. |
| 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. |
| AIProjectMemoryStoresOperations |
The AIProjectMemoryStoresOperations sub-client. |
| AIProjectTelemetry |
Provides telemetry-related operations for the project. |
| AzureAIAgentTarget |
Represents a target specifying an Azure AI agent. |
| AzureAIAssistantTarget |
Represents a target specifying an Azure AI Assistant (Agent V1) endpoint, including its id. |
| AzureAIModelTarget |
Represents a target specifying an Azure AI model for operations requiring model selection. |
| 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. |
| AzureOpenAIModelConfiguration |
Azure OpenAI model configuration. The API version would be selected by the service for querying the model. |
| BlobReferenceSasCredential |
SAS Credential definition. |
| ChartCoordinate |
Coordinates for the analysis chart. |
| ChatSummaryMemoryItem |
A memory item containing a summary extracted from conversations. |
| ClientConnectionProviderExtensions | |
| ClusterInsightResult |
Insights from the cluster analysis. |
| ClusterTokenUsage |
Token usage for cluster analysis. |
| CodeBasedEvaluatorDefinition |
Code-based evaluator definition using python code. |
| ContinuousEvaluationRuleAction |
Evaluation rule action for continuous evaluation. |
| CreateAgentVersionFromManifestRequest |
The CreateAgentVersionFromManifestRequest. |
| CronTrigger |
Cron based trigger. |
| DailyRecurrenceSchedule |
Daily recurrence schedule. |
| DatasetCredential |
Represents a reference to a blob for consumption. |
| DeleteMemoryStoreResponse |
The DeleteMemoryStoreResponse. |
| EmbeddingConfiguration |
Embedding configuration class. |
| EvalCompareReport |
Insights from the evaluation comparison. |
| EvalResult |
Result of the evaluation. |
| EvalRunResultCompareItem |
Metric comparison for a treatment against the baseline. |
| EvalRunResultComparison |
Comparison results for treatment runs against the baseline. |
| EvalRunResultSummary |
Summary statistics of a metric in an evaluation run. |
| EvaluationComparisonRequest |
Evaluation Comparison Request. |
| EvaluationResultSample |
A sample from the evaluation result. |
| EvaluationRule |
Evaluation rule model. |
| EvaluationRuleAction |
Evaluation action model. Please note this is the abstract base class. The derived classes available for instantiation are: ContinuousEvaluationRuleAction and HumanEvaluationRuleAction. |
| EvaluationRuleFilter |
Evaluation filter model. |
| EvaluationRules |
The EvaluationRules sub-client. |
| EvaluationRunClusterInsightResult |
Insights from the evaluation run cluster analysis. |
| EvaluationRunClusterInsightsRequest |
Insights on set of Evaluation Results. |
| EvaluationScheduleTask |
Evaluation task for the schedule. |
| EvaluationScheduleTaskEvalRun |
The EvaluationScheduleTaskEvalRun. |
| EvaluationTaxonomies |
The EvaluationTaxonomies sub-client. |
| EvaluationTaxonomy |
Evaluation Taxonomy Definition. |
| EvaluationTaxonomyInput |
Input configuration for the evaluation taxonomy. Please note this is the abstract base class. The derived classes available for instantiation are: AgentTaxonomyInput. |
| EvaluatorDefinition |
Base evaluator configuration with discriminator Please note this is the abstract base class. The derived classes available for instantiation are: CodeBasedEvaluatorDefinition and PromptBasedEvaluatorDefinition. |
| EvaluatorMetric |
Evaluator Metric. |
| Evaluators |
The Evaluators sub-client. |
| EvaluatorVersion |
Evaluator Definition. |
| FileDataset |
FileDatasetVersion Definition. |
| FolderDataset |
FileDatasetVersion Definition. |
| HourlyRecurrenceSchedule |
Hourly recurrence schedule. |
| HumanEvaluationRuleAction |
Evaluation rule action for human evaluation. |
| 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. Please note this is the abstract base class. The derived classes available for instantiation are: EvaluationRunClusterInsightsRequest, AgentClusterInsightsRequest, and EvaluationComparisonRequest. |
| InsightResult |
The result of the insights. Please note this is the abstract base class. The derived classes available for instantiation are: EvalCompareReport, EvaluationRunClusterInsightResult, and AgentClusterInsightResult. |
| Insights |
The Insights sub-client. |
| InsightSample |
A sample from the analysis. Please note this is the abstract base class. The derived classes available for instantiation are: EvaluationResultSample. |
| InsightScheduleTask |
Insight task for the schedule. |
| InsightsMetadata |
Metadata about the insights. |
| InsightSummary |
Summary of the error cluster analysis. |
| ManagedAzureAISearchIndex |
Managed Azure AI Search Index Definition. |
| MemoryItem |
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 and ChatSummaryMemoryItem. |
| MemoryOperation |
Represents a single memory operation (create, update, or delete) performed on a memory item. |
| MemorySearchItem |
A retrieved memory item from memory search. |
| MemorySearchOptions | |
| MemorySearchResultOptions |
Memory search options. |
| MemoryStore |
A memory store that can store and retrieve user memories. |
| MemoryStoreDefaultDefinition |
Default memory store implementation. |
| MemoryStoreDefaultOptions |
Default memory store configurations. |
| MemoryStoreDefinition |
Base definition for memory store configurations. Please note this is the abstract base class. The derived classes available for instantiation are: MemoryStoreDefaultDefinition. |
| MemoryStoreDeleteScopeResponse |
Response for deleting memories from a scope. |
| MemoryStoreOperationUsage |
Usage statistics of a memory store operation. |
| MemoryStoreOperationUsageInputTokensDetails |
The MemoryStoreOperationUsageInputTokensDetails. |
| MemoryStoreOperationUsageOutputTokensDetails |
The MemoryStoreOperationUsageOutputTokensDetails. |
| MemoryStoreSearchResponse |
Memory search response. |
| MemoryUpdateOptions | |
| MemoryUpdateResult |
Provides the status of a memory store update operation. |
| MemoryUpdateResultDetails |
Memory update result. |
| ModelDeployment |
Model Deployment Definition. |
| ModelDeploymentSku |
Sku information. |
| ModelSamplingParams |
Represents a set of parameters used to control the sampling behavior of a language model during text generation. |
| MonthlyRecurrenceSchedule |
Monthly recurrence schedule. |
| NoAuthenticationCredentials |
Credentials that do not require authentication. |
| OneTimeTrigger |
One-time trigger. |
| PendingUploadConfiguration |
Represents a request for a pending upload. |
| PendingUploadResult |
Represents the response for a pending upload request. |
| PromptBasedEvaluatorDefinition |
Prompt-based evaluator. |
| RecurrenceSchedule |
Recurrence schedule model. Please note this is the abstract base class. The derived classes available for instantiation are: HourlyRecurrenceSchedule, DailyRecurrenceSchedule, WeeklyRecurrenceSchedule, and MonthlyRecurrenceSchedule. |
| RecurrenceTrigger |
Recurrence based trigger. |
| RedTeam |
Red team details. |
| RedTeams |
The RedTeams sub-client. |
| Schedule |
Schedule model. |
| ScheduleRun |
Schedule run model. |
| Schedules |
The Schedules sub-client. |
| ScheduleTask |
Schedule task model. Please note this is the abstract base class. The derived classes available for instantiation are: EvaluationScheduleTask and InsightScheduleTask. |
| Target |
Base class for targets with discriminator support. Please note this is the abstract base class. The derived classes available for instantiation are: AzureAIAgentTarget, AzureAIModelTarget, and AzureAIAssistantTarget. |
| TargetConfig |
Abstract class for target configuration. Please note this is the abstract base class. The derived classes available for instantiation are: AzureOpenAIModelConfiguration. |
| TaxonomyCategory |
Taxonomy category definition. |
| TaxonomySubCategory |
Taxonomy sub-category definition. |
| ToolDescription |
Description of a tool that can be used by an agent. |
| Trigger |
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. |
| UserProfileMemoryItem |
A memory item specifically containing user profile information extracted from conversations, such as preferences, interests, and personal details. |
| WeeklyRecurrenceSchedule |
Weekly recurrence schedule. |
Structs
| Name | Description |
|---|---|
| AgentKind | |
| AgentListOrder | |
| AIProjectDeploymentType | |
| AttackStrategy |
Strategies for attacks. |
| ConnectionType |
The Type (or category) of the connection. |
| DayOfWeek |
Days of the week for recurrence schedule. |
| EvaluationRuleActionType |
Type of the evaluation action. |
| EvaluationRuleEventType |
Type of the evaluation rule event. |
| EvaluatorCategory |
The category of the evaluator. |
| 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. |
| InsightType |
The request of the insights. |
| ListVersionsRequestType | |
| MemoryOperationKind |
Memory operation kind. |
| PendingUploadType |
The type of pending upload. |
| RiskCategory |
Risk category for the attack objective. |
| ScheduleProvisioningStatus |
Schedule provisioning status. |
| TreatmentEffectType |
Treatment Effect Type. |
Enums
| Name | Description |
|---|---|
| AIProjectClientOptions.ServiceVersion |
The version of the service to use. |
| MemoryStoreUpdateStatus |
Status of a memory store update operation. |