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

Update Endpoint - Update Endpoint

汇报由给定 ID 标识的终结点的元数据。

PATCH {Endpoint}/speechtotext/v3.0/endpoints/{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

对象的名称。

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

EndpointPropertiesUpdate

EndpointPropertiesUpdate

响应

名称 类型 说明
200 OK

Endpoint

确定

标头

Retry-After: integer

Other Status Codes

Error

出现了错误。

安全性

Ocp-Apim-Subscription-Key

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

类型: apiKey
在: header

Authorization

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

类型: apiKey
在: header

示例

Update an endpoint

示例请求

PATCH https://westus.api.cognitive.microsoft.com//speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6

{
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "properties": {
    "contentLoggingEnabled": true
  },
  "displayName": "Updated endpoint with new model",
  "customProperties": {
    "key": "value"
  }
}

示例响应

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
    "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
  },
  "properties": {
    "timeToLive": "PT30M",
    "loggingEnabled": true
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Speech endpoint",
  "description": "Example for speech endpoint"
}

定义

名称 说明
DetailedErrorCode

DetailedErrorCode

Endpoint

终结点

EndpointLinks

EndpointLinks

EndpointProperties

EndpointProperties

EndpointPropertiesUpdate

EndpointPropertiesUpdate

EndpointUpdate

EndpointUpdate

EntityError

EntityError

EntityReference

EntityReference

Error

错误

ErrorCode

ErrorCode

InnerError

InnerError

Status

状态

DetailedErrorCode

DetailedErrorCode

名称 类型 说明
DataImportFailed

string

数据导入失败。

DeleteNotAllowed

string

不允许删除。

DeployNotAllowed

string

不允许部署。

DeployingFailedModel

string

部署失败的模型。

EmptyRequest

string

空请求。

EndpointCannotBeDefault

string

终结点不能为默认值。

EndpointNotUpdatable

string

终结点不可更新。

EndpointWithoutLogging

string

没有日志记录的终结点。

ExceededNumberOfRecordingsUris

string

已超出录制 URI 数。

FailedDataset

string

失败的数据集。

Forbidden

string

已禁止。

InUseViolation

string

在使用中冲突。

InaccessibleCustomerStorage

string

无法访问的客户存储。

InvalidAdaptationMapping

string

无效的适应映射。

InvalidBaseModel

string

基本模型无效。

InvalidCallbackUri

string

回调 URI 无效。

InvalidCollection

string

集合无效。

InvalidDataset

string

数据集无效。

InvalidDocument

string

无效的文档。

InvalidDocumentBatch

string

无效的文档批处理。

InvalidLocale

string

区域设置无效。

InvalidLogDate

string

日志日期无效。

InvalidLogEndTime

string

日志结束时间无效。

InvalidLogId

string

日志 ID 无效。

InvalidLogStartTime

string

日志开始时间无效。

InvalidModel

string

无效的模型。

InvalidModelUri

string

无效的模型 URI。

InvalidParameter

string

参数无效。

InvalidParameterValue

string

参数值无效。

InvalidPayload

string

有效负载无效。

InvalidPermissions

string

权限无效。

InvalidPrerequisite

string

先决条件无效。

InvalidProductId

string

产品 ID 无效。

InvalidProject

string

无效的项目。

InvalidProjectKind

string

无效的项目类型。

InvalidRecordingsUri

string

录制 URI 无效。

InvalidRequestBodyFormat

string

请求正文格式无效。

InvalidSasValidityDuration

string

sas 有效性持续时间无效。

InvalidSkipTokenForLogs

string

日志的跳过令牌无效。

InvalidSubscription

string

订阅无效。

InvalidTest

string

测试无效。

InvalidTimeToLive

string

生存时间无效。

InvalidTopForLogs

string

日志顶部无效。

InvalidTranscription

string

听录无效。

InvalidWebHookEventKind

string

Web 挂钩事件类型无效。

MissingInputRecords

string

缺少输入记录。

ModelDeploymentNotCompleteState

string

模型部署未完成状态。

ModelDeprecated

string

模型已弃用。

ModelExists

string

模型存在。

ModelMismatch

string

模型不匹配。

ModelNotDeployable

string

模型不可部署。

ModelVersionIncorrect

string

模型版本不正确。

NoUtf8WithBom

string

没有带有 bom 的 utf8。

OnlyOneOfUrlsOrContainerOrDataset

string

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

ProjectGenderMismatch

string

项目性别不匹配。

QuotaViolation

string

配额冲突。

SingleDefaultEndpoint

string

单个默认终结点。

SkuLimitsExist

string

存在 SKU 限制。

SubscriptionNotFound

string

找不到订阅。

UnexpectedError

string

意外错误。

UnsupportedClassBasedAdaptation

string

不支持的基于类的适应。

UnsupportedDelta

string

不支持的增量。

UnsupportedDynamicConfiguration

string

不支持的动态配置。

UnsupportedFilter

string

不支持的筛选器。

UnsupportedLanguageCode

string

不支持的语言代码。

UnsupportedOrderBy

string

不支持的订单依据。

UnsupportedPagination

string

不支持的分页。

UnsupportedTimeRange

string

不支持的时间范围。

Endpoint

终结点

名称 类型 说明
createdDateTime

string

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

customProperties

object

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

description

string

对象的说明。

displayName

string

对象的显示名称。

lastActionDateTime

string

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

links

EndpointLinks

EndpointLinks

locale

string

包含数据的区域设置。

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

EndpointProperties

EndpointProperties

self

string

此实体的位置。

status

Status

状态
描述 API 的当前状态

text

string

用于为此终结点调整语言模型的文本。

EndpointLinks

名称 类型 说明
logs

string

此终结点的音频和听录日志。

restConversation

string

请求的 REST 终结点,最长为 60 秒。

restDictation

string

请求的 REST 终结点长达 60 秒,支持标点符号听写。

restInteractive

string

用于短时间请求的 REST 终结点,最长为 15 秒。

webSocketConversation

string

用于具有多个最终结果的长请求的语音 SDK 终结点。

webSocketDictation

string

用于具有多个最终结果的长请求的语音 SDK 终结点,支持标点符号听写。

webSocketInteractive

string

用于短时间请求的语音 SDK 终结点,最长为 15 秒,并显示单个最终结果。

EndpointProperties

EndpointProperties

名称 类型 说明
email

string

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

error

EntityError

EntityError

loggingEnabled

boolean

一个 值,该值指示是否将内容日志记录 (音频 & 听录) 用于部署。

timeToLive

string

终结点将在系统中保留多长时间。 终结点在完成后达到生存时间后 (成功或失败) 将自动删除。 不将此值或设置为 0 将禁用自动删除。 支持的最长持续时间为 31 天。 持续时间编码为 ISO 8601 持续时间 (“PnYnMnDTnHnMnS”,请参阅 https://en.wikipedia.org/wiki/ISO_8601#Durations) 。

EndpointPropertiesUpdate

EndpointPropertiesUpdate

名称 类型 说明
contentLoggingEnabled

boolean

一个 值,该值指示是否将内容日志记录 (音频 & 听录) 用于部署。

EndpointUpdate

EndpointUpdate

名称 类型 说明
customProperties

object

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

description

string

对象的说明。

displayName

string

对象的名称。

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

EndpointPropertiesUpdate

EndpointPropertiesUpdate

EntityError

EntityError

名称 类型 说明
code

string

此错误的代码。

message

string

此错误的消息。

EntityReference

EntityReference

名称 类型 说明
self

string

被引用实体的位置。

Error

错误

名称 类型 说明
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

错误的源。 例如,如果文档无效,应为“文档”或“文档 ID”。

ErrorCode

ErrorCode

名称 类型 说明
Conflict

string

表示冲突错误代码。

Forbidden

string

表示禁止的错误代码。

InternalCommunicationFailed

string

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

InternalServerError

string

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

InvalidArgument

string

表示无效参数错误代码。

InvalidRequest

string

表示无效请求错误代码。

NotAllowed

string

表示不允许的错误代码。

NotFound

string

表示“找不到”错误代码。

PipelineError

string

表示管道错误代码。

ServiceUnavailable

string

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

TooManyRequests

string

表示请求过多错误代码。

Unauthorized

string

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

UnprocessableEntity

string

表示不可处理的实体错误代码。

UnsupportedMediaType

string

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

InnerError

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

错误的源。 例如,如果文档无效,应为“文档”或“文档 ID”。

Status

状态

名称 类型 说明
Failed

string

长时间运行的操作失败。

NotStarted

string

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

Running

string

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

Succeeded

string

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