次の方法で共有

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

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名、例: 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

エラーコード
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

言語マークダウン データセット。
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 またはコンテナーまたはデータセットのいずれか 1 つだけ。
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

ログの top が無効です。
InvalidSkipTokenForLogs

ログのスキップ トークンが無効です。
DeleteNotAllowed

削除は許可されていません。
Forbidden

禁じられた。
DeployNotAllowed

デプロイは許可されていません。
UnexpectedError

予期しないエラー。
InvalidCollection

コレクションが無効です。
InvalidCallbackUri

コールバック URI が無効です。
InvalidSasValidityDuration

SAS の有効期間が無効です。
InaccessibleCustomerStorage

お客様のストレージにアクセスできません。
UnsupportedClassBasedAdaptation

サポートされていないクラス ベースの適応。
InvalidWebHookEventKind

Web フック イベントの種類が無効です。
InvalidTimeToLive

有効期限が無効です。
InvalidSourceAzureResourceId

ソース Azure リソース ID が無効です。
ModelCopyOperationExists

モデルのコピー操作が存在します。

Error

Object

エラー

名前 型 説明
code

ErrorCode

エラーコード
大まかなエラー コード。
details

Error[]

エラーや予想されるポリシーに関するその他のサポートの詳細。
innerError

InnerError

InnerError
https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owで利用可能な Cognitive Services API ガイドラインに準拠した新しい内部エラー形式。 これには、必須プロパティ ErrorCode、メッセージ、および省略可能なプロパティ ターゲット、details(キー値ペア)、内部エラー (入れ子にできます) が含まれます。
message

string

高レベルのエラー メッセージ。
target

string

エラーの原因。 たとえば、無効なドキュメントの場合は "documents" または "document id" になります。

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
https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owで利用可能な Cognitive Services API ガイドラインに準拠した新しい内部エラー形式。 これには、必須プロパティ ErrorCode、メッセージ、および省略可能なプロパティ ターゲット、details(キー値ペア)、内部エラー (入れ子にできます) が含まれます。
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

実行時間の長い操作が失敗しました。