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

Endpoints - Get

参考

服务:: Azure AI Services

API 版本:: v3.1

获取由给定 ID 标识的终结点。

GET {endpoint}/speechtotext/v3.1/endpoints/{id}

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	支持的认知服务终结点 (协议和主机名，例如： https://westus.api.cognitive.microsoft.com) 。
id	path	True	string (uuid)	终结点的标识符。

响应

名称	类型	说明
200 OK	Endpoint	确定标头 Retry-After: integer
Other Status Codes	Error	出现了错误。

名称

类型

说明

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

示例

Get an endpoint

示例请求

HTTP

GET {endpoint}/speechtotext/v3.1/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6

示例响应

状态代码:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/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
EntityError	EntityError
EntityReference	EntityReference
Error	错误
ErrorCode	ErrorCode
InnerError	InnerError
Status	状态

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	日志的跳过令牌无效。
InvalidSubscription	无效的订阅。
InvalidTest	测试无效。
InvalidTimeToLive	生存时间无效。
InvalidTopForLogs	日志顶部无效。
InvalidTranscription	听录无效。
InvalidWebHookEventKind	Web 挂钩事件类型无效。
MissingInputRecords	缺少输入记录。
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	不支持的时间范围。

Endpoint

Object

终结点

名称	类型	说明
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。
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	EndpointLinks	EndpointLinks
locale	string minLength: 1	包含数据的区域设置。
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	EndpointProperties
self	string (uri)	此实体的位置。
status	Status	状态描述 API 的当前状态
text	string	用于为此终结点调整语言模型的文本。

EndpointLinks

Object

EndpointLinks

名称	类型	说明
logs	string (uri)	此终结点的音频和听录日志。有关更多详细信息，请参阅操作“Endpoints_ListLogs”。
restConversation	string (uri)	请求的 REST 终结点，最长为 60 秒。
restDictation	string (uri)	请求的 REST 终结点长达 60 秒，支持标点符号听写。
restInteractive	string (uri)	用于短时间请求的 REST 终结点，最长为 15 秒。
webSocketConversation	string (uri)	用于具有多个最终结果的长请求的语音 SDK 终结点。
webSocketDictation	string (uri)	用于具有多个最终结果的长请求的语音 SDK 终结点，支持标点符号听写。
webSocketInteractive	string (uri)	用于短时间请求的语音 SDK 终结点，最长为 15 秒，并显示单个最终结果。

EndpointProperties

Object

EndpointProperties

名称	类型	说明
email	string	要向其发送电子邮件通知的电子邮件地址，以防操作完成。成功发送电子邮件后，将删除该值。
error	EntityError	EntityError
loggingEnabled	boolean	一个值，该值指示是否将内容日志记录 (音频 & 听录) 用于部署。
timeToLive	string	终结点将在系统中保留多长时间。终结点在完成后达到生存时间后 (成功或失败) 将自动删除。不将此值或设置为 0 将禁用自动删除。支持的最长持续时间为 31 天。持续时间编码为 ISO 8601 持续时间 (“PnYnMnDTnHnMnS”，请参阅 https://en.wikipedia.org/wiki/ISO_8601#Durations) 。

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	错误的源。例如，如果文档无效，应为“文档”或“文档 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	错误的源。例如，如果文档无效，应为“文档”或“文档 ID”。

Status

枚举

状态

值	说明
Failed	长时间运行的操作失败。
NotStarted	长时间运行的操作尚未启动。
Running	长时间运行的操作当前正在处理。
Succeeded	长时间运行的操作已成功完成。

通过

Endpoints - Get

URI 参数

响应

安全性

Ocp-Apim-Subscription-Key

Authorization

示例

Get an endpoint

示例请求

示例响应

定义

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

Status

其他资源