@azure/ai-projects package
Classes
| AIProjectClient |
The operation groups for telemetry |
Interfaces
@azure/ai-projects.Index| AIProjectClientOptionalParams |
Optional parameters for the client. |
| ApiKeyCredentials |
API Key Credential definition |
| AssetCredentialResponse |
Represents a reference to a blob for consumption |
| AzureAISearchIndex |
Azure AI Search Index Definition |
| AzureOpenAIClientOptions |
The options for configuring the Azure OpenAI client. |
| 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 |
| DatasetUploadOptions |
Options for uploading datasets |
| 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 |
| FieldMapping |
Field mapping configuration class |
| FileDatasetVersion |
FileDatasetVersion Definition |
| FolderDatasetVersion |
FileDatasetVersion Definition |
| GetAzureOpenAIClientOptions |
Options for getting the Azure OpenAI client. |
| IndexesCreateOrUpdateOptionalParams |
Optional parameters. |
| IndexesDeleteOptionalParams |
Optional parameters. |
| IndexesGetOptionalParams |
Optional parameters. |
| IndexesListOptionalParams |
Optional parameters. |
| IndexesListVersionsOptionalParams |
Optional parameters. |
| IndexesOperations |
Interface representing a Indexes operations. |
| InferenceOperations |
Inference operations interface for AI projects. |
| 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 |
| SASCredentials |
Shared Access Signature (SAS) credential definition |
| SasCredential |
SAS Credential definition |
| Sku |
Sku information |
| TelemetryOperations |
Interface representing telemetry operations |
Type Aliases
| 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 |
| IndexType |
Type of IndexType |
| IndexUnion |
Alias for IndexUnion |
| PendingUploadType |
The type of pending upload. |
Enums
| KnownVersions |
Azure AI Projects API versions |