通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Models - Update

  • 参考
服务:
Azure AI Services
API 版本:
v3.2-preview.2

更新由给定 ID 标识的模型的元数据。

PATCH {endpoint}/speechtotext/v3.2-preview.2/models/{id}

URI 参数

名称 在 必需 类型 说明
endpoint
 path True

string

支持的认知服务终结点（协议和主机名，例如：https://westus.api.cognitive.microsoft.com）。
id
 path True

string (uuid)

模型的标识符。

请求正文

Media Types: "application/json", "application/merge-patch+json"

名称 类型 说明
customProperties

object

此实体的自定义属性。 允许的最大密钥长度为 64 个字符，允许的最大值长度为 256 个字符，允许的条目计数为 10。
description

string

对象的说明。
displayName

string

对象的名称。
project

EntityReference

EntityReference

响应

名称 类型 说明
200 OK

CustomModel

还行

标头

Retry-After: integer
Other Status Codes

Error

发生错误。

安全性

Ocp-Apim-Subscription-Key

在此处提供认知服务帐户密钥。

类型: apiKey
在: header

Authorization

提供来自此区域的 STS 返回的 JWT 的访问令牌。 通过将以下查询字符串添加到 STS URL，确保将管理范围添加到令牌： ？scope=speechservicesmanagement

类型: apiKey
在: header

示例

Update a model

示例请求

PATCH {endpoint}/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b

{
  "displayName": "Language model update",
  "description": "This is a language model update",
  "customProperties": {
    "key": "value"
  }
}

示例响应

状态代码:
200 
{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b",
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
    "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
    "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
  },
  "properties": {
    "deprecationDates": {
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "customModelWeightPercent": 30,
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": false,
      "supportedOutputFormats": [
        "Lexical",
        "Display"
      ]
    }
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Running",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Language model",
  "description": "This is a language model"
}

定义

名称 说明
CustomModel

CustomModel
CustomModelDeprecationDates

CustomModelDeprecationDates
CustomModelFeatures

CustomModelFeatures
CustomModelLinks

CustomModelLinks
CustomModelProperties

CustomModelProperties
DetailedErrorCode

DetailedErrorCode
EntityError

EntityError
EntityReference

EntityReference
Error

错误
ErrorCode

ErrorCode
InnerError

InnerError
ModelUpdate

ModelUpdate
OutputFormatType

OutputFormatType
Status

状态

CustomModel

Object

CustomModel

名称 类型 说明
baseModel

EntityReference

EntityReference
createdDateTime

string (date-time)

创建对象的时间戳。 时间戳编码为 ISO 8601 日期和时间格式（“YYYY-MM-DDThh：mm：ssZ”，请参阅 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations）。
customProperties

object

此实体的自定义属性。 允许的最大密钥长度为 64 个字符，允许的最大值长度为 256 个字符，允许的条目计数为 10。
datasets

EntityReference[]

用于适应的数据集。
description

string

对象的说明。
displayName

string

minLength: 1

对象的显示名称。
lastActionDateTime

string (date-time)

输入当前状态时的时间戳。 时间戳编码为 ISO 8601 日期和时间格式（“YYYY-MM-DDThh：mm：ssZ”，请参阅 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations）。
links

CustomModelLinks

CustomModelLinks
locale

string

minLength: 1

包含数据的区域设置。
project

EntityReference

EntityReference
properties

CustomModelProperties

CustomModelProperties
self

string (uri)

此实体的位置。
status

Status

状态
描述 API 的当前状态
text

string

用于调整此语言模型的文本。

CustomModelDeprecationDates

Object

CustomModelDeprecationDates

名称 类型 说明
transcriptionDateTime

string (date-time)

听录已弃用的日期。

CustomModelFeatures

Object

CustomModelFeatures

名称 类型 说明
supportedOutputFormats

OutputFormatType[]

支持的输出格式。
supportsEndpoints

boolean

一个值，该值指示是否支持为实时听录创建终结点。
supportsTranscriptions

boolean

一个值，该值指示是否支持批量听录。
supportsTranscriptionsOnSpeechContainers

boolean

一个值，该值指示此模型是否可用于语音容器的听录。 当此功能在语音容器上可用时，可以在现有模型上添加此功能。
Object

CustomModelLinks

名称 类型 说明
copy

string (uri)

模型复制作的位置。 有关更多详细信息，请参阅作“Models_Copy”。
copyTo

string (uri)

已过时模型复制作的位置。 有关详细信息，请参阅作“Models_CopyTo”。
files

string (uri)

获取此实体的所有文件的位置。 有关详细信息，请参阅作“Models_ListFiles”。
manifest

string (uri)

要获取此模型的清单的位置，该模型将用于本地容器。 有关详细信息，请参阅作“Models_GetCustomModelManifest”。

CustomModelProperties

Object

CustomModelProperties

名称 类型 说明
customModelWeightPercent

integer (int32)

minimum: 1
maximum: 100

自定义模型（1 个% 自定义模型和 99 个% 基本模型）和 100（100% 自定义模型和 0 个% 基本模型）之间的权重。 如果未设置此属性，服务将选择适当的值（获取模型以检索所选权重）。 在不使用此属性的情况下启动。 如果需要，请选择更大的（或更小）的权重来增加（或减少）自定义模型的影响。
deprecationDates

CustomModelDeprecationDates

CustomModelDeprecationDates
email

string

要发送电子邮件通知的电子邮件地址，以防作完成。 成功发送电子邮件后，将删除该值。
error

EntityError

EntityError
features

CustomModelFeatures

CustomModelFeatures
模型支持的功能。

DetailedErrorCode

枚举

DetailedErrorCode

值 说明
DataImportFailed

数据导入失败。
DeleteNotAllowed

不允许删除。
DeployNotAllowed

不允许部署。
DeployingFailedModel

部署失败的模型。
EmptyRequest

空请求。
EndpointCannotBeDefault

终结点不能为默认值。
EndpointNotUpdatable

终结点不可更新。
EndpointWithoutLogging

没有日志记录的终结点。
ExceededNumberOfRecordingsUris

超过录制 URI 数。
FailedDataset

失败的数据集。
Forbidden

禁止。
InUseViolation

在使用冲突中。
InaccessibleCustomerStorage

无法访问客户存储。
InvalidAdaptationMapping

适应映射无效。
InvalidBaseModel

基本模型无效。
InvalidCallbackUri

回调 URI 无效。
InvalidCollection

集合无效。
InvalidDataset

数据集无效。
InvalidDocument

无效的文档。
InvalidDocumentBatch

文档批处理无效。
InvalidLocale

区域设置无效。
InvalidLogDate

日志日期无效。
InvalidLogEndTime

日志结束时间无效。
InvalidLogId

无效的日志 ID。
InvalidLogStartTime

无效的日志开始时间。
InvalidModel

无效的模型。
InvalidModelUri

模型 URI 无效。
InvalidParameter

参数无效。
InvalidParameterValue

参数值无效。
InvalidPayload

有效负载无效。
InvalidPermissions

权限无效。
InvalidPrerequisite

先决条件无效。
InvalidProductId

产品 ID 无效。
InvalidProject

项目无效。
InvalidProjectKind

项目类型无效。
InvalidRecordingsUri

录制 URI 无效。
InvalidRequestBodyFormat

请求正文格式无效。
InvalidSasValidityDuration

SAS 有效期无效。
InvalidSkipTokenForLogs

日志的跳过令牌无效。
InvalidSourceAzureResourceId

源 Azure 资源 ID 无效。
InvalidSubscription

订阅无效。
InvalidTest

测试无效。
InvalidTimeToLive

生存时间无效。
InvalidTopForLogs

日志顶部无效。
InvalidTranscription

听录无效。
InvalidWebHookEventKind

Web 挂钩事件类型无效。
MissingInputRecords

缺少输入记录。
ModelCopyOperationExists

模型复制作存在。
ModelDeploymentNotCompleteState

模型部署未完成状态。
ModelDeprecated

模型已弃用。
ModelExists

模型存在。
ModelMismatch

模型不匹配。
ModelNotDeployable

模型不可部署。
ModelVersionIncorrect

模型版本不正确。
NoUtf8WithBom

没有带有 bom 的 utf8。
OnlyOneOfUrlsOrContainerOrDataset

只有一个 URL 或容器或数据集。
ProjectGenderMismatch

项目性别不匹配。
QuotaViolation

配额冲突。
SingleDefaultEndpoint

单个默认终结点。
SkuLimitsExist

SKU 限制存在。
SubscriptionNotFound

找不到订阅。
UnexpectedError

意外错误。
UnsupportedClassBasedAdaptation

不支持的基于类的适应。
UnsupportedDelta

不支持的增量。
UnsupportedDynamicConfiguration

不支持的动态配置。
UnsupportedFilter

不支持的筛选器。
UnsupportedLanguageCode

不支持的语言代码。
UnsupportedOrderBy

不受支持的订单依据。
UnsupportedPagination

不支持的分页。
UnsupportedTimeRange

不支持的时间范围。

EntityError

Object

EntityError

名称 类型 说明
code

string

此错误的代码。
message

string

此错误的消息。

EntityReference

Object

EntityReference

名称 类型 说明
self

string (uri)

引用实体的位置。

Error

Object

错误

名称 类型 说明
code

ErrorCode

ErrorCode
高级错误代码。
details

Error[]

有关错误和/或预期策略的其他支持详细信息。
innerError

InnerError

InnerError
符合认知服务 API 准则的新内部错误格式，可在 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow获取。 这包括必需的属性 ErrorCode、消息和可选属性目标、详细信息（键值对）、内部错误（可嵌套）。
message

string

高级错误消息。
target

string

错误的源。 例如，如果文档无效，则为“documents”或“document id”。

ErrorCode

枚举

ErrorCode

值 说明
Conflict

表示冲突错误代码。
Forbidden

表示禁止的错误代码。
InternalCommunicationFailed

表示内部通信失败的错误代码。
InternalServerError

表示内部服务器错误代码。
InvalidArgument

表示无效的参数错误代码。
InvalidRequest

表示无效的请求错误代码。
NotAllowed

表示不允许的错误代码。
NotFound

表示找不到的错误代码。
PipelineError

表示管道错误代码。
ServiceUnavailable

表示服务不可用的错误代码。
TooManyRequests

表示请求错误代码过多。
Unauthorized

表示未经授权的错误代码。
UnprocessableEntity

表示无法处理的实体错误代码。
UnsupportedMediaType

表示不支持的媒体类型错误代码。

InnerError

Object

InnerError

名称 类型 说明
code

DetailedErrorCode

DetailedErrorCode
详细的错误代码枚举。
details

object

有关错误和/或预期策略的其他支持详细信息。
innerError

InnerError

InnerError
符合认知服务 API 准则的新内部错误格式，可在 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow获取。 这包括必需的属性 ErrorCode、消息和可选属性目标、详细信息（键值对）、内部错误（可嵌套）。
message

string

高级错误消息。
target

string

错误的源。 例如，如果文档无效，则为“documents”或“document id”。

ModelUpdate

Object

ModelUpdate

名称 类型 说明
customProperties

object

此实体的自定义属性。 允许的最大密钥长度为 64 个字符，允许的最大值长度为 256 个字符，允许的条目计数为 10。
description

string

对象的说明。
displayName

string

对象的名称。
project

EntityReference

EntityReference

OutputFormatType

枚举

OutputFormatType

值 说明
Display

模型支持显示格式听录输出或终结点。
Lexical

模型提供不带格式的听录输出。

Status

枚举

状态

值 说明
Failed

长时间运行的作失败。
NotStarted

长时间运行的作尚未启动。
Running

长时间运行的作当前正在处理。
Succeeded

长时间运行的作已成功完成。