@azure/arm-aiinfraoptimization package

Classes

AIInfraOptimizationClient

Interfaces

AIInfraOptimizationClientOptionalParams	Optional parameters for the client.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
RecommendVmSkuAccelerator	The accelerator hardware available in each virtual machine.
RecommendVmSkuBenchmark	The external benchmark evidence selected for one virtual machine size option.
RecommendVmSkuCost	The deployment cost for one virtual machine size option.
RecommendVmSkuDeployment	Deployment scale and procurement inputs.
RecommendVmSkuHourlyCost	A currency-qualified deployment-wide hourly cost.
RecommendVmSkuMemory	The memory calculation shared by every returned option.
RecommendVmSkuModel	Model inputs used for metadata resolution and memory sizing.
RecommendVmSkuOptimization	Ranking preference and optional deployment-wide hourly cost limit.
RecommendVmSkuOption	One ranked virtual machine size recommendation.
RecommendVmSkuPerformanceEstimate	An advisory deployment throughput and per-request latency estimate.
RecommendVmSkuPlacement	The capacity placement evidence for one virtual machine size option.
RecommendVmSkuQuota	The subscription quota evidence for one virtual machine size option.
RecommendVmSkuQuotaIncrease	The quota limits to raise before retrying a deployment.
RecommendVmSkuQuotaLimit	One quota limit that blocks the requested deployment.
RecommendVmSkuReadiness	How ready a recommended option is to deploy.
RecommendVmSkuRequest	The parameters used to request an Azure virtual machine size recommendation for an AI workload.
RecommendVmSkuResponse	The recommended Azure virtual machine sizes for the workload, with the sizing calculation they were derived from.
RecommendVmSkuSizing	The resolved workload sizing shared by every recommended option.
RecommendVmSkuSizingBasis	The sources used for the sizing calculation.
RecommendVmSkuSizingModel	The resolved model identity and weight precision.
RecommendVmSkuSizingWorkload	The resolved per-replica workload inputs used for memory sizing.
RecommendVmSkuStageError	An error from an optional subscription-scoped recommendation stage.
RecommendVmSkuSubscriptionOptions	The subscription-scoped lookups to include in the recommendation.
RecommendVmSkuTokenBudget	The per-request token budget used to size the inference key-value cache.
RecommendVmSkuTopology	The deployment topology for one virtual machine size option.
RecommendVmSkuWorkload	Inference workload assumptions that affect memory sizing.
RecommendationsOperations	Interface representing a Recommendations operations.
RecommendationsRecommendVmSkuOptionalParams	Optional parameters.

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
BenchmarkLevel	How closely benchmark evidence matches a recommended topology. KnownBenchmarkLevel can be used interchangeably with BenchmarkLevel, this enum contains the known values that the service supports. Known values supported by the service Benchmarked: The accelerator family has benchmark evidence at a different topology. TopologyMatched: The benchmark matches the recommended node and accelerator counts.
ContextLengthSource	Where a context length was resolved from. KnownContextLengthSource can be used interchangeably with ContextLengthSource, this enum contains the known values that the service supports. Known values supported by the service Request: The context length is the sum of the request's workload.tokenBudget.promptTokens and maxOutputTokens. Default: No token budget was supplied, so the service default context length was used.
ContinuablePage	An interface that describes a page of results.
CostSource	The source a price was resolved from. KnownCostSource can be used interchangeably with CostSource, this enum contains the known values that the service supports. Known values supported by the service AzureRetail: The price came from the public Azure retail catalog. AzureSubscription: The price came from the caller's Azure subscription. StaticPreview: The price is fixed illustrative data for a contract preview.
ModelWeightsCalculation	How model weight memory was calculated. KnownModelWeightsCalculation can be used interchangeably with ModelWeightsCalculation, this enum contains the known values that the service supports. Known values supported by the service ArtifactSize: The memory was calculated from the published model artifact size. EstimatedFromParameterCount: The memory was estimated from the model parameter count.
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
ParameterCountSource	Where a model parameter count was resolved from. KnownParameterCountSource can be used interchangeably with ParameterCountSource, this enum contains the known values that the service supports. Known values supported by the service Request: The parameter count was supplied in the request. HuggingFace: The parameter count was resolved from Hugging Face metadata.
PlacementStatus	The outcome of a capacity placement query. KnownPlacementStatus can be used interchangeably with PlacementStatus, this enum contains the known values that the service supports. Known values supported by the service Evaluated: The placement check completed successfully. Failed: The placement check failed. NotEvaluated: The placement check was not run. Unsupported: The placement check is not supported for this option.
ProcurementOption	The Azure virtual machine procurement option. KnownProcurementOption can be used interchangeably with ProcurementOption, this enum contains the known values that the service supports. Known values supported by the service OnDemand: Use standard on-demand capacity. Spot: Use interruptible Spot capacity.
QuotaStatus	Whether subscription quota is sufficient for a requested deployment. KnownQuotaStatus can be used interchangeably with QuotaStatus, this enum contains the known values that the service supports. Known values supported by the service Available: Quota is sufficient for the requested replicas. Unavailable: Quota is insufficient for the requested replicas. Unknown: Quota could not be determined.
RankingPreference	The preference used to rank the recommended options. KnownRankingPreference can be used interchangeably with RankingPreference, this enum contains the known values that the service supports. Known values supported by the service Cost: Rank the options by deployment cost. Latency: Rank the options by inference latency.
ReadinessStatus	The current actionability of a recommended option. KnownReadinessStatus can be used interchangeably with ReadinessStatus, this enum contains the known values that the service supports. Known values supported by the service ReadyToAttempt: The option can be attempted without a known prerequisite action. QuotaIncreaseRequired: The option requires a quota increase before deployment. VerificationRequired: The option requires an external verification before deployment. Unavailable: The option is not available to the subscription in the requested region.
StageErrorCode	The reason an optional subscription-scoped stage did not complete. KnownStageErrorCode can be used interchangeably with StageErrorCode, this enum contains the known values that the service supports. Known values supported by the service TimedOut: The stage exceeded its deadline. Throttled: The stage was throttled. PartitionCapacityExceeded: The service reached its active caller partition capacity. DependencyError: A downstream dependency call failed. DataUnavailable: Required downstream data was unavailable. EvaluationBudgetExceeded: The optional evaluation call budget was exhausted.
WeightPrecision	The precision a model's weights are served at. KnownWeightPrecision can be used interchangeably with WeightPrecision, this enum contains the known values that the service supports. Known values supported by the service FP32: 32-bit floating point. FP16: 16-bit floating point. BF16: 16-bit brain floating point. FP8: 8-bit floating point. INT8: 8-bit integer. INT4: 4-bit integer. FP4: 4-bit floating point.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownBenchmarkLevel	How closely benchmark evidence matches a recommended topology.
KnownContextLengthSource	Where a context length was resolved from.
KnownCostSource	The source a price was resolved from.
KnownModelWeightsCalculation	How model weight memory was calculated.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownParameterCountSource	Where a model parameter count was resolved from.
KnownPlacementStatus	The outcome of a capacity placement query.
KnownProcurementOption	The Azure virtual machine procurement option.
KnownQuotaStatus	Whether subscription quota is sufficient for a requested deployment.
KnownRankingPreference	The preference used to rank the recommended options.
KnownReadinessStatus	The current actionability of a recommended option.
KnownStageErrorCode	The reason an optional subscription-scoped stage did not complete.
KnownVersions	The available API versions.
KnownWeightPrecision	The precision a model's weights are served at.

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor