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
| AgentEvaluation |
Evaluation response for agent evaluation run. |
| AgentEvaluationRedactionConfiguration |
The redaction configuration will allow the user to control what is redacted. |
| AgentEvaluationRequest |
Evaluation request for agent run. |
| AgentEvaluationResult |
Result for the agent evaluation evaluator run. |
| AgentEvaluationSamplingConfiguration |
Definition for sampling strategy. |
| AIProjectClient |
The AzureAI service client. |
| AIProjectClientOptions |
Client options for AIProjectClient. |
| AIProjectsModelFactory |
Model factory for models. |
| ApiKeyCredentials |
API Key Credential definition. |
| AssetCredentialResponse |
Represents a reference to a blob for consumption. |
| AzureAIProjectsContext |
Context class which will be filled in by the System.ClientModel.SourceGeneration. For more information see 'https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/System.ClientModel/src/docs/ModelReaderWriterContext.md' |
| AzureAISearchIndex |
Azure AI Search Index Definition. |
| AzureOpenAIModelConfiguration |
Azure OpenAI model configuration. The API version would be selected by the service for querying the model. |
| BaseCredentials |
A base class for connection credentials Please note BaseCredentials 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 EntraIDCredentials, ApiKeyCredentials, CustomCredential, NoAuthenticationCredentials and SASCredentials. |
| BlobReference |
Blob reference details. |
| Connection |
Response from the list and get connections operations. |
| Connections |
The Connections sub-client. |
| CosmosDBIndex |
CosmosDB Vector Store Index Definition. |
| CustomCredential |
Custom credential definition. |
| Datasets |
The Datasets sub-client. |
| DatasetVersion |
DatasetVersion Definition Please note DatasetVersion 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 FileDatasetVersion and FolderDatasetVersion. |
| Deployment |
Model Deployment Definition Please note Deployment 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 ModelDeployment. |
| Deployments |
The Deployments sub-client. |
| EmbeddingConfiguration |
Embedding configuration class. |
| EntraIDCredentials |
Entra ID credential definition. |
| Evaluation |
Evaluation Definition. |
| Evaluations |
The Evaluations sub-client. |
| EvaluatorConfiguration |
Evaluator Configuration. |
| EvaluatorIDs |
Evaluator IDs for built-in evaluators. |
| FieldMapping |
Field mapping configuration class. |
| FileDatasetVersion |
FileDatasetVersion Definition. |
| FolderDatasetVersion |
FileDatasetVersion Definition. |
| Index |
Index resource Definition Please note Index 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 AzureAISearchIndex, CosmosDBIndex and ManagedAzureAISearchIndex. |
| Indexes |
The Indexes sub-client. |
| InputData |
Abstract data class. Please note InputData 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 InputDataset. |
| InputDataset |
Dataset as source for evaluation. |
| ManagedAzureAISearchIndex |
Managed Azure AI Search Index Definition. |
| ModelDeployment |
Model Deployment Definition. |
| NoAuthenticationCredentials |
Credentials that do not require authentication. |
| PendingUploadRequest |
Represents a request for a pending upload. |
| PendingUploadResponse |
Represents the response for a pending upload request. |
| RedTeam |
Red team details. |
| RedTeams |
The RedTeams sub-client. |
| SasCredential |
SAS Credential definition. |
| SASCredentials |
Shared Access Signature (SAS) credential definition. |
| ServicePatterns |
The ServicePatterns sub-client. |
| Sku |
Sku information. |
| TargetConfig |
Abstract class for target configuration. Please note TargetConfig 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 AzureOpenAIModelConfiguration. |
| Telemetry |
Provides telemetry-related operations for the project. |
Structs
| AttackStrategy |
Strategies for attacks. |
| ConnectionType |
The Type (or category) of the connection. |
| DeploymentType |
The DeploymentType. |
| PendingUploadType |
The type of pending upload. |
| RiskCategory |
Risk category for the attack objective. |
| SasCredentialType |
The SasCredentialType. |
Enums
| AIProjectClientOptions.ServiceVersion |
The version of the service to use. |
| AuthenticationType |
Authentication type used by Azure AI service to connect to another service. |
