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

Models - List Base Models

参考

服务:: Azure AI Services

API 版本:: v3.1

获取经过身份验证的订阅的基本模型列表。

GET {endpoint}/speechtotext/v3.1/models/base

具有可选参数:

GET {endpoint}/speechtotext/v3.1/models/base?skip={skip}&top={top}&filter={filter}

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	支持的认知服务终结点 (协议和主机名，例如： https://westus.api.cognitive.microsoft.com) 。
filter	query		string	用于选择可用基础模型的子集的筛选表达式。 `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=status eq 'NotStarted' or status eq 'Running'`
skip	query		integer int32	将跳过的数据集数。
top	query		integer int32	跳过后将包含的数据集数。

响应

名称	类型	说明
200 OK	PaginatedBaseModels	确定
Other Status Codes	Error	出现了错误。

安全性

Ocp-Apim-Subscription-Key

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

类型: apiKey
在: header

Authorization

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

类型: apiKey
在: header

示例

Get all english base models

示例请求

HTTP

GET {endpoint}/speechtotext/v3.1/models/base?skip=0&top=2&filter=locale%20eq%20'en-US'

示例响应

状态代码:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/827712a5-f942-4997-91c3-7c6cde35600b",
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "properties": {
        "deprecationDates": {
          "adaptationDateTime": "2022-11-04T00:00:00Z",
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": true,
          "supportsAdaptationsWith": [
            "Language",
            "Acoustic"
          ]
        }
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "en-US Base model"
    }
  ]
}

定义

名称	说明
BaseModel	BaseModel
BaseModelDeprecationDates	BaseModelDeprecationDates
BaseModelFeatures	BaseModelFeatures
BaseModelLinks	BaseModelLinks
BaseModelProperties	BaseModelProperties
DatasetKind	DatasetKind
DetailedErrorCode	DetailedErrorCode
Error	错误
ErrorCode	ErrorCode
InnerError	InnerError
PaginatedBaseModels	PaginatedBaseModels
Status	状态

BaseModel

名称	类型	说明
createdDateTime	string	创建对象时的时间戳。时间戳编码为 ISO 8601 日期和时间格式 (“YYYY-MM-DDThh：mm：ssZ”，请参阅 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) 。
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	BaseModelLinks	BaseModelLinks
locale	string	包含数据的区域设置。
properties	BaseModelProperties	BaseModelProperties
self	string	此实体的位置。
status	Status	状态描述 API 的当前状态

BaseModelDeprecationDates

名称	类型	说明
adaptationDateTime	string	已弃用适应的日期。
transcriptionDateTime	string	已弃用听录的日期。

BaseModelFeatures

名称	类型	说明
supportsAdaptationsWith	DatasetKind[]	支持用于调整模型的数据集类型。
supportsEndpoints	boolean	一个值，该值指示是否支持为实时听录创建终结点。
supportsTranscriptions	boolean	一个值，该值指示是否支持批量听录。
supportsTranscriptionsOnSpeechContainers	boolean	一个值，该值指示此模型是否可用于语音容器上的听录。当此功能在语音容器上可用时，可以在现有模型上添加此功能。

BaseModelLinks

名称	类型	说明
manifest	string	获取要在本地容器中使用的此模型的清单的位置。有关更多详细信息，请参阅操作“Models_GetCustomModelManifest”。

BaseModelProperties

名称	类型	说明
deprecationDates	BaseModelDeprecationDates	BaseModelDeprecationDates
features	BaseModelFeatures	BaseModelFeatures 模型支持的功能。

DatasetKind

名称	类型	说明
Acoustic	string	声学数据集。
AudioFiles	string	音频文件数据集。
Language	string	语言数据集。
LanguageMarkdown	string	语言 markdown 数据集。
Pronunciation	string	发音数据集。

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	不支持的时间范围。

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

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

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

PaginatedBaseModels

名称	类型	说明
@nextLink	string	如果有更多可用的实体，则提供指向下一组分页结果的链接;否则为 null。
values	BaseModel[]	受传递的查询参数“skip”和“top”或其默认值限制的实体列表。使用分页和并行删除实体循环访问列表时，结果中将跳过某些实体。建议在客户端上生成一个列表，并在提取完整列表后将其删除。

名称

类型

说明

@nextLink

string

如果有更多可用的实体，则提供指向下一组分页结果的链接;否则为 null。

values

BaseModel[]

受传递的查询参数“skip”和“top”或其默认值限制的实体列表。

使用分页和并行删除实体循环访问列表时，结果中将跳过某些实体。建议在客户端上生成一个列表，并在提取完整列表后将其删除。

Status

状态

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

通过