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. |
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, and NoAuthenticationCredentials. |
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. |
ApiKeyCredentials |
API Key Credential definition. |
AssetDeployment |
Model Deployment Definition Please note this is the abstract base class. The derived classes available for instantiation are: ModelDeployment. |
AssistantMessage |
A message generated by the assistant in response to previous messages. |
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. |
BaseCredentials |
A base class for connection credentials Please note this is the abstract base class. The derived classes available for instantiation are: ApiKeyCredentials, EntraIDCredentials, CustomCredential, SASCredentials, and NoAuthenticationCredentials. |
BlobReference |
Blob reference details. |
BlobReferenceSasCredential |
SAS Credential definition. |
ConnectionProperties |
Response from the list and get connections operations. |
ConnectionsOperations |
The ConnectionsOperations sub-client. |
CosmosDBIndex |
CosmosDB Vector Store Index Definition. |
CustomCredential |
Custom credential definition. |
DatasetCredential |
Represents a reference to a blob for consumption. |
DatasetsOperations |
The DatasetsOperations 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. |
DeploymentsOperations |
The DeploymentsOperations sub-client. |
DeveloperMessage |
A message authored by a developer to guide the model during evaluation. |
EmbeddingConfiguration |
Embedding configuration class. |
EntraIDCredentials |
Entra ID credential definition. |
Evaluation |
Evaluation Definition. |
Evaluations |
The Evaluations sub-client. |
EvaluationTarget |
Abstract base model for defining evaluation targets. Please note this is the abstract base class. The derived classes available for instantiation are: ModelResponseGenerationTarget. |
EvaluatorConfiguration |
Evaluator Configuration. |
EvaluatorIDs |
Evaluator IDs for built-in evaluators. |
FieldMapping |
Field mapping configuration class. |
FileDataset |
FileDatasetVersion Definition. |
FileDatasetVersion |
FileDatasetVersion Definition. |
FolderDataset |
FileDatasetVersion Definition. |
FolderDatasetVersion |
FileDatasetVersion Definition. |
IndexesOperations |
The IndexesOperations sub-client. |
InputData |
Abstract data class. Please note this is the abstract base class. The derived classes available for instantiation are: InputDataset. |
InputDataset |
Dataset as source for evaluation. |
ManagedAzureAISearchIndex |
Managed Azure AI Search Index Definition. |
Message |
Abstract base model representing a single message in a conversation. Please note this is the abstract base class. The derived classes available for instantiation are: SystemMessage, DeveloperMessage, UserMessage, and AssistantMessage. |
ModelDeployment |
Model Deployment Definition. |
ModelDeploymentSku |
Sku information. |
ModelResponseGenerationTarget |
Evaluation target for generating responses using a given model and dataset. |
NoAuthenticationCredentials |
Credentials that do not require authentication. |
PendingUploadConfiguration |
Represents a request for a pending upload. |
PendingUploadResult |
Represents the response for a pending upload request. |
RedTeam |
Red team details. |
RedTeams |
The RedTeams sub-client. |
SASCredentials |
Shared Access Signature (SAS) credential definition. |
SearchIndex |
Index resource Definition Please note this is the abstract base class. The derived classes available for instantiation are: AzureAISearchIndex, ManagedAzureAISearchIndex, and CosmosDBIndex. |
SystemMessage |
A message authored by the system to guide model behavior. |
TargetConfig |
Abstract class for target configuration. Please note this is the abstract base class. The derived classes available for instantiation are: AzureOpenAIModelConfiguration. |
Telemetry |
Provides telemetry-related operations for the project. |
UserMessage |
A message authored by the end user as input to the model. |
Structs
AIProjectDeploymentType | |
AttackStrategy |
Strategies for attacks. |
ConnectionType |
The Type (or category) of the connection. |
DeploymentType | |
PendingUploadType |
The type of pending upload. |
RiskCategory |
Risk category for the attack objective. |
Enums
AIProjectClientOptions.ServiceVersion |
The version of the service to use. |
AuthenticationType |
Authentication type used by Azure AI service to connect to another service. |