models Package
Classes
AbusePenalty |
The abuse penalty. |
Account |
Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU. Variables are only populated by the server, and will be ignored when sending a request. |
AccountListResult |
The list of cognitive services accounts operation response. Variables are only populated by the server, and will be ignored when sending a request. |
AccountModel |
Cognitive Services account Model. Variables are only populated by the server, and will be ignored when sending a request. |
AccountModelListResult |
The list of cognitive services accounts operation response. |
AccountProperties |
Properties of Cognitive Services account. Variables are only populated by the server, and will be ignored when sending a request. |
AccountSku |
Cognitive Services resource type and SKU. |
AccountSkuListResult |
The list of cognitive services accounts operation response. |
ApiKeys |
The access keys for the cognitive services account. |
ApiProperties |
The api properties for special APIs. |
AzureEntityResource |
The resource model definition for an Azure Resource Manager resource with an etag. Variables are only populated by the server, and will be ignored when sending a request. |
BillingMeterInfo |
BillingMeterInfo. |
CalculateModelCapacityParameter |
Calculate Model Capacity parameter. |
CalculateModelCapacityResult |
Calculate Model Capacity result. |
CalculateModelCapacityResultEstimatedCapacity |
Model Estimated Capacity. |
CallRateLimit |
The call rate limit Cognitive Services account. |
CapacityConfig |
The capacity configuration. |
CheckDomainAvailabilityParameter |
Check Domain availability parameter. All required parameters must be populated in order to send to server. |
CheckSkuAvailabilityParameter |
Check SKU availability parameter. All required parameters must be populated in order to send to server. |
CommitmentCost |
Cognitive Services account commitment cost. |
CommitmentPeriod |
Cognitive Services account commitment period. Variables are only populated by the server, and will be ignored when sending a request. |
CommitmentPlan |
Cognitive Services account commitment plan. Variables are only populated by the server, and will be ignored when sending a request. |
CommitmentPlanAccountAssociation |
The commitment plan association. Variables are only populated by the server, and will be ignored when sending a request. |
CommitmentPlanAccountAssociationListResult |
The list of cognitive services Commitment Plan Account Association operation response. Variables are only populated by the server, and will be ignored when sending a request. |
CommitmentPlanAssociation |
The commitment plan association. |
CommitmentPlanListResult |
The list of cognitive services accounts operation response. Variables are only populated by the server, and will be ignored when sending a request. |
CommitmentPlanProperties |
Properties of Cognitive Services account commitment plan. Variables are only populated by the server, and will be ignored when sending a request. |
CommitmentQuota |
Cognitive Services account commitment quota. |
CommitmentTier |
Cognitive Services account commitment tier. |
CommitmentTierListResult |
The list of cognitive services accounts operation response. Variables are only populated by the server, and will be ignored when sending a request. |
CustomBlocklistConfig |
Gets or sets the source to which filter applies. |
DefenderForAISetting |
The Defender for AI resource. Variables are only populated by the server, and will be ignored when sending a request. |
DefenderForAISettingResult |
The list of cognitive services Defender for AI Settings. |
Deployment |
Cognitive Services account deployment. Variables are only populated by the server, and will be ignored when sending a request. |
DeploymentCapacitySettings |
Internal use only. |
DeploymentListResult |
The list of cognitive services accounts operation response. Variables are only populated by the server, and will be ignored when sending a request. |
DeploymentModel |
Properties of Cognitive Services account deployment model. Variables are only populated by the server, and will be ignored when sending a request. |
DeploymentProperties |
Properties of Cognitive Services account deployment. Variables are only populated by the server, and will be ignored when sending a request. |
DeploymentScaleSettings |
Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.). Variables are only populated by the server, and will be ignored when sending a request. |
DeploymentSkuListResult |
The list of cognitive services accounts operation response. Variables are only populated by the server, and will be ignored when sending a request. |
DomainAvailability |
Domain availability. |
Encryption |
Properties to configure Encryption. |
EncryptionScope |
Cognitive Services EncryptionScope. Variables are only populated by the server, and will be ignored when sending a request. |
EncryptionScopeListResult |
The list of cognitive services EncryptionScopes. |
EncryptionScopeProperties |
Properties to EncryptionScope. Variables are only populated by the server, and will be ignored when sending a request. |
ErrorAdditionalInfo |
The resource management error additional info. Variables are only populated by the server, and will be ignored when sending a request. |
ErrorDetail |
The error detail. Variables are only populated by the server, and will be ignored when sending a request. |
ErrorResponse |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). |
Identity |
Identity for the resource. Variables are only populated by the server, and will be ignored when sending a request. |
IpRule |
A rule governing the accessibility from a specific ip address or ip range. All required parameters must be populated in order to send to server. |
KeyVaultProperties |
Properties to configure keyVault Properties. |
MetricName |
A metric name. |
Model |
Cognitive Services Model. |
ModelCapacityCalculatorWorkload |
Model Capacity Calculator Workload. |
ModelCapacityCalculatorWorkloadRequestParam |
Dictionary, Model Capacity Calculator Workload Parameters. |
ModelCapacityListResult |
The list of cognitive services accounts operation response. |
ModelCapacityListResultValueItem |
ModelCapacityListResultValueItem. Variables are only populated by the server, and will be ignored when sending a request. |
ModelDeprecationInfo |
Cognitive Services account ModelDeprecationInfo. |
ModelListResult |
The list of cognitive services models. |
ModelSku |
Describes an available Cognitive Services Model SKU. |
ModelSkuCapacityProperties |
Cognitive Services account ModelSkuCapacity. |
MultiRegionSettings |
The multiregion settings Cognitive Services account. |
NetworkRuleSet |
A set of rules governing the network accessibility. |
NetworkSecurityPerimeter |
Information about a linked Network Security Perimeter. |
NetworkSecurityPerimeterAccessRule |
Network Security Perimeter Access Rule. |
NetworkSecurityPerimeterAccessRuleProperties |
The Properties of Network Security Perimeter Rule. |
NetworkSecurityPerimeterAccessRulePropertiesSubscriptionsItem |
Subscription for inbound rule. |
NetworkSecurityPerimeterConfiguration |
NSP Configuration for an Cognitive Services account. Variables are only populated by the server, and will be ignored when sending a request. |
NetworkSecurityPerimeterConfigurationAssociationInfo |
Network Security Perimeter Configuration Association Information. |
NetworkSecurityPerimeterConfigurationList |
A list of NSP configurations for an Cognitive Services account. |
NetworkSecurityPerimeterConfigurationProperties |
The properties of an NSP Configuration. Variables are only populated by the server, and will be ignored when sending a request. |
NetworkSecurityPerimeterProfileInfo |
Network Security Perimeter Profile Information. |
Operation |
Details of a REST API operation, returned from the Resource Provider Operations API. Variables are only populated by the server, and will be ignored when sending a request. |
OperationDisplay |
Localized display information for this particular operation. Variables are only populated by the server, and will be ignored when sending a request. |
OperationListResult |
A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. Variables are only populated by the server, and will be ignored when sending a request. |
PatchResourceTags |
The object being used to update tags of a resource, in general used for PATCH operations. |
PatchResourceTagsAndSku |
The object being used to update tags and sku of a resource, in general used for PATCH operations. |
PrivateEndpoint |
The Private Endpoint resource. Variables are only populated by the server, and will be ignored when sending a request. |
PrivateEndpointConnection |
The Private Endpoint Connection resource. Variables are only populated by the server, and will be ignored when sending a request. |
PrivateEndpointConnectionListResult |
A list of private endpoint connections. |
PrivateEndpointConnectionProperties |
Properties of the PrivateEndpointConnectProperties. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
PrivateLinkResource |
A private link resource. Variables are only populated by the server, and will be ignored when sending a request. |
PrivateLinkResourceListResult |
A list of private link resources. |
PrivateLinkResourceProperties |
Properties of a private link resource. Variables are only populated by the server, and will be ignored when sending a request. |
PrivateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
ProvisioningIssue |
ProvisioningIssue. |
ProvisioningIssueProperties |
Properties of Provisioning Issue. |
ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location. Variables are only populated by the server, and will be ignored when sending a request. |
QuotaLimit |
QuotaLimit. |
RaiBlockListItemsResult |
The list of cognitive services RAI Blocklist Items. |
RaiBlockListResult |
The list of cognitive services RAI Blocklists. |
RaiBlocklist |
Cognitive Services RaiBlocklist. Variables are only populated by the server, and will be ignored when sending a request. |
RaiBlocklistConfig |
Azure OpenAI blocklist config. |
RaiBlocklistItem |
Cognitive Services RaiBlocklist Item. Variables are only populated by the server, and will be ignored when sending a request. |
RaiBlocklistItemBulkRequest |
The Cognitive Services RaiBlocklist Item request body. |
RaiBlocklistItemProperties |
RAI Custom Blocklist Item properties. |
RaiBlocklistProperties |
RAI Custom Blocklist properties. |
RaiContentFilter |
Azure OpenAI Content Filter. Variables are only populated by the server, and will be ignored when sending a request. |
RaiContentFilterListResult |
The list of Content Filters. |
RaiContentFilterProperties |
Azure OpenAI Content Filter Properties. |
RaiMonitorConfig |
Cognitive Services Rai Monitor Config. |
RaiPolicy |
Cognitive Services RaiPolicy. Variables are only populated by the server, and will be ignored when sending a request. |
RaiPolicyContentFilter |
Azure OpenAI Content Filter. |
RaiPolicyListResult |
The list of cognitive services RaiPolicies. |
RaiPolicyProperties |
Azure OpenAI Content Filters properties. Variables are only populated by the server, and will be ignored when sending a request. |
RegenerateKeyParameters |
Regenerate key parameters. All required parameters must be populated in order to send to server. |
RegionSetting |
The call rate limit Cognitive Services account. |
RequestMatchPattern |
RequestMatchPattern. |
Resource |
Common fields that are returned in the response for all Azure Resource Manager resources. Variables are only populated by the server, and will be ignored when sending a request. |
ResourceSku |
Describes an available Cognitive Services SKU. |
ResourceSkuListResult |
The Get Skus operation response. All required parameters must be populated in order to send to server. |
ResourceSkuRestrictionInfo |
ResourceSkuRestrictionInfo. |
ResourceSkuRestrictions |
Describes restrictions of a SKU. |
Sku |
The resource model definition representing SKU. All required parameters must be populated in order to send to server. |
SkuAvailability |
SKU availability. |
SkuAvailabilityListResult |
Check SKU availability result list. |
SkuCapability |
SkuCapability indicates the capability of a certain feature. |
SkuChangeInfo |
Sku change info of account. |
SkuResource |
Properties of Cognitive Services account resource sku resource properties. |
SystemData |
Metadata pertaining to creation and last modification of the resource. |
ThrottlingRule |
ThrottlingRule. |
Usage |
The usage data for a usage request. |
UsageListResult |
The response to a list usage request. |
UserAssignedIdentity |
User-assigned managed identity. Variables are only populated by the server, and will be ignored when sending a request. |
UserOwnedAmlWorkspace |
The user owned AML workspace for Cognitive Services account. |
UserOwnedStorage |
The user owned storage for Cognitive Services account. |
VirtualNetworkRule |
A rule governing the accessibility from a specific virtual network. All required parameters must be populated in order to send to server. |
Enums
AbusePenaltyAction |
The action of AbusePenalty. |
ActionType |
Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. |
ByPassSelection |
Setting for trusted services. |
CommitmentPlanProvisioningState |
Gets the status of the resource at the time the operation was called. |
ContentLevel |
Level at which content is filtered. |
CreatedByType |
The type of identity that created the resource. |
DefenderForAISettingState |
Defender for AI state on the AI resource. |
DeploymentModelVersionUpgradeOption |
Deployment model version upgrade option. |
DeploymentProvisioningState |
Gets the status of the resource at the time the operation was called. |
DeploymentScaleType |
Deployment scale type. |
EncryptionScopeProvisioningState |
Gets the status of the resource at the time the operation was called. |
EncryptionScopeState |
The encryptionScope state. |
HostingModel |
Account hosting model. |
KeyName |
key name to generate (Key1|Key2). |
KeySource |
Enumerates the possible value of keySource for Encryption. |
ModelLifecycleStatus |
Model lifecycle status. |
NetworkRuleAction |
The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. |
NspAccessRuleDirection |
Direction of Access Rule. |
Origin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system". |
PrivateEndpointConnectionProvisioningState |
The current provisioning state. |
PrivateEndpointServiceConnectionStatus |
The private endpoint connection status. |
ProvisioningState |
Gets the status of the cognitive services account at the time the operation was called. |
PublicNetworkAccess |
Whether or not public endpoint access is allowed for this account. |
QuotaUsageStatus |
Cognitive Services account quota usage status. |
RaiPolicyContentSource |
Content source to apply the Content Filters. |
RaiPolicyMode |
Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2024-10-01. It is the same as 'Deferred' in previous version. |
RaiPolicyType |
Content Filters policy type. |
ResourceIdentityType |
The identity type. |
ResourceSkuRestrictionsReasonCode |
The reason for restriction. |
ResourceSkuRestrictionsType |
The type of restrictions. |
RoutingMethods |
Multiregion routing methods. |
SkuTier |
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. |
UnitType |
The unit of the metric. |
Azure SDK for Python