通过

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

Models - List Base Models

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

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

GET {endpoint}/speechtotext/v3.2-preview.2/models/base
具有可选参数: 
GET {endpoint}/speechtotext/v3.2-preview.2/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

示例请求

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

示例响应

状态代码:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b",
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/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"
          ],
          "supportedOutputFormats": [
            "Display",
            "Lexical"
          ]
        },
        "chargeForAdaptation": true
      },
      "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
OutputFormatType

OutputFormatType
PaginatedBaseModels

PaginatedBaseModels
Status

状态

BaseModel

Object

BaseModel

名称 类型 说明
createdDateTime

string (date-time)

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

BaseModelLinks

BaseModelLinks
locale

string

minLength: 1

包含数据的区域设置。
properties

BaseModelProperties

BaseModelProperties
self

string (uri)

此实体的位置。
status

Status

状态
描述 API 的当前状态

BaseModelDeprecationDates

Object

BaseModelDeprecationDates

名称 类型 说明
adaptationDateTime

string (date-time)

适应已弃用的日期。
transcriptionDateTime

string (date-time)

听录已弃用的日期。

BaseModelFeatures

Object

BaseModelFeatures

名称 类型 说明
supportedOutputFormats

OutputFormatType[]

支持的输出格式。
supportsAdaptationsWith

DatasetKind[]

支持的数据集类型以适应模型。
supportsEndpoints

boolean

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

boolean

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

boolean

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

BaseModelLinks

名称 类型 说明
manifest

string (uri)

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

BaseModelProperties

Object

BaseModelProperties

名称 类型 说明
chargeForAdaptation

boolean

一个值，该值指示模型适应是否收费。
deprecationDates

BaseModelDeprecationDates

BaseModelDeprecationDates
features

BaseModelFeatures

BaseModelFeatures
模型支持的功能。

DatasetKind

枚举

DatasetKind

值 说明
Language

语言数据集。
Acoustic

声学数据集。
Pronunciation

发音数据集。
AudioFiles

音频文件数据集。
LanguageMarkdown

语言 markdown 数据集。
OutputFormatting

包含用于自定义反向文本规范化、大写、重整、亵渎以及定义数据集验证测试的数据集

DetailedErrorCode

枚举

DetailedErrorCode

值 说明
InvalidParameterValue

参数值无效。
InvalidRequestBodyFormat

请求正文格式无效。
EmptyRequest

空请求。
MissingInputRecords

缺少输入记录。
InvalidDocument

无效的文档。
ModelVersionIncorrect

模型版本不正确。
InvalidDocumentBatch

文档批处理无效。
UnsupportedLanguageCode

不支持的语言代码。
DataImportFailed

数据导入失败。
InUseViolation

在使用冲突中。
InvalidLocale

区域设置无效。
InvalidBaseModel

基本模型无效。
InvalidAdaptationMapping

适应映射无效。
InvalidDataset

数据集无效。
InvalidTest

测试无效。
FailedDataset

失败的数据集。
InvalidModel

无效的模型。
InvalidTranscription

听录无效。
InvalidPayload

有效负载无效。
InvalidParameter

参数无效。
EndpointWithoutLogging

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

权限无效。
InvalidPrerequisite

先决条件无效。
InvalidProductId

产品 ID 无效。
InvalidSubscription

订阅无效。
InvalidProject

项目无效。
InvalidProjectKind

项目类型无效。
InvalidRecordingsUri

录制 URI 无效。
OnlyOneOfUrlsOrContainerOrDataset

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

超过录制 URI 数。
ModelMismatch

模型不匹配。
ProjectGenderMismatch

项目性别不匹配。
ModelDeprecated

模型已弃用。
ModelExists

模型存在。
ModelNotDeployable

模型不可部署。
EndpointNotUpdatable

终结点不可更新。
SingleDefaultEndpoint

单个默认终结点。
EndpointCannotBeDefault

终结点不能为默认值。
InvalidModelUri

模型 URI 无效。
SubscriptionNotFound

找不到订阅。
QuotaViolation

配额冲突。
UnsupportedDelta

不支持的增量。
UnsupportedFilter

不支持的筛选器。
UnsupportedPagination

不支持的分页。
UnsupportedDynamicConfiguration

不支持的动态配置。
UnsupportedOrderBy

不受支持的订单依据。
NoUtf8WithBom

没有带有 bom 的 utf8。
ModelDeploymentNotCompleteState

模型部署未完成状态。
SkuLimitsExist

SKU 限制存在。
DeployingFailedModel

部署失败的模型。
UnsupportedTimeRange

不支持的时间范围。
InvalidLogDate

日志日期无效。
InvalidLogId

无效的日志 ID。
InvalidLogStartTime

无效的日志开始时间。
InvalidLogEndTime

日志结束时间无效。
InvalidTopForLogs

日志顶部无效。
InvalidSkipTokenForLogs

日志的跳过令牌无效。
DeleteNotAllowed

不允许删除。
Forbidden

禁止。
DeployNotAllowed

不允许部署。
UnexpectedError

意外错误。
InvalidCollection

集合无效。
InvalidCallbackUri

回调 URI 无效。
InvalidSasValidityDuration

SAS 有效期无效。
InaccessibleCustomerStorage

无法访问客户存储。
UnsupportedClassBasedAdaptation

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

Web 挂钩事件类型无效。
InvalidTimeToLive

生存时间无效。
InvalidSourceAzureResourceId

源 Azure 资源 ID 无效。
ModelCopyOperationExists

模型复制作存在。

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

值 说明
InvalidRequest

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

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

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

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

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

表示管道错误代码。
Conflict

表示冲突错误代码。
InternalCommunicationFailed

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

表示禁止的错误代码。
NotAllowed

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

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

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

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

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

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”。

OutputFormatType

枚举

OutputFormatType

值 说明
Lexical

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

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

PaginatedBaseModels

Object

PaginatedBaseModels

名称 类型 说明
@nextLink

string (uri)

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

BaseModel[]

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

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

Status

枚举

状态

值 说明
NotStarted

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

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

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

长时间运行的作失败。