Share via


@azure/ai-projects package

Classes

AIProjectClient

The operation groups for enabling telemetry

Interfaces

@azure/ai-projects.Index
AIProjectClientOptionalParams

Optional parameters for the client.

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.

ApiKeyCredentials

API Key Credential definition

AssetCredentialResponse

Represents a reference to a blob for consumption

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

BlobReference

Blob reference details.

Connection

Response from the list and get connections operations

ConnectionsGetOptionalParams

Optional parameters.

ConnectionsGetWithCredentialsOptionalParams

Optional parameters.

ConnectionsListOptionalParams

Optional parameters.

ConnectionsOperations

Interface representing a Connections operations.

CosmosDBIndex

CosmosDB Vector Store Index Definition

CustomCredential

Custom credential definition

DatasetVersion

DatasetVersion Definition

DatasetsCreateOrUpdateOptionalParams

Optional parameters.

DatasetsDeleteOptionalParams

Optional parameters.

DatasetsGetCredentialsOptionalParams

Optional parameters.

DatasetsGetOptionalParams

Optional parameters.

DatasetsListOptionalParams

Optional parameters.

DatasetsListVersionsOptionalParams

Optional parameters.

DatasetsOperations

Interface representing a Datasets operations.

DatasetsPendingUploadOptionalParams

Optional parameters.

Deployment

Model Deployment Definition

DeploymentsGetOptionalParams

Optional parameters.

DeploymentsListOptionalParams

Optional parameters.

DeploymentsOperations

Interface representing a Deployments operations.

EmbeddingConfiguration

Embedding configuration class

EntraIDCredentials

Entra ID credential definition

Evaluation

Evaluation Definition

EvaluationsCreateAgentEvaluationOptionalParams

Optional parameters.

EvaluationsCreateOptionalParams

Optional parameters.

EvaluationsGetOptionalParams

Optional parameters.

EvaluationsListOptionalParams

Optional parameters.

EvaluationsOperations

Interface representing a Evaluations operations.

EvaluatorConfiguration

Evaluator Configuration

FieldMapping

Field mapping configuration class

FileDatasetVersion

FileDatasetVersion Definition

FolderDatasetVersion

FileDatasetVersion Definition

IndexesCreateOrUpdateOptionalParams

Optional parameters.

IndexesDeleteOptionalParams

Optional parameters.

IndexesGetOptionalParams

Optional parameters.

IndexesListOptionalParams

Optional parameters.

IndexesListVersionsOptionalParams

Optional parameters.

IndexesOperations

Interface representing a Indexes operations.

InputData

Abstract data class.

InputDataset

Dataset as source for evaluation.

ManagedAzureAISearchIndex

Managed Azure AI Search Index Definition

ModelDeployment

Model Deployment Definition

NoAuthenticationCredentials

Credentials that do not require authentication

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PendingUploadRequest

Represents a request for a pending upload.

PendingUploadResponse

Represents the response for a pending upload request

RedTeam

Red team details.

RedTeamsCreateOptionalParams

Optional parameters.

RedTeamsGetOptionalParams

Optional parameters.

RedTeamsListOptionalParams

Optional parameters.

RedTeamsOperations

Interface representing a RedTeams operations.

SASCredentials

Shared Access Signature (SAS) credential definition

SasCredential

SAS Credential definition

Sku

Sku information

TargetConfig

Abstract class for target configuration.

TelemetryOperations

Interface representing telemetry operations

Type Aliases

AttackStrategy

Strategies for attacks.

BaseCredentialsUnion

Alias for BaseCredentialsUnion

ConnectionType

The Type (or category) of the connection

ContinuablePage

An interface that describes a page of results.

CredentialType

The credential type used by the connection

DatasetType

Enum to determine the type of data.

DatasetVersionUnion

Alias for DatasetVersionUnion

DeploymentType

Type of DeploymentType

DeploymentUnion

Alias for DeploymentUnion

EnableTelemetryType

The type of enableTelemetry method

EvaluationWithOptionalName

optional id property for Evaluation, which shouldbe used for create operation

EvaluatorId

Type for EvaluatorIds values

IndexType

Type of IndexType

IndexUnion

Alias for IndexUnion

InputDataUnion

Alias for InputDataUnion

PendingUploadType

The type of pending upload.

RiskCategory

Risk category for the attack objective.

TargetConfigUnion

Alias for TargetConfigUnion

Enums

KnownVersions

Azure AI Projects API versions