Models - Get Base Model

リファレンス

サービス:: Azure AI Services

API バージョン:: v3.2-preview.2

指定された ID で識別される基本モデルを取得します。

GET {endpoint}/speechtotext/v3.2-preview.2/models/base/{id}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名、例: https://westus.api.cognitive.microsoft.com)。
id	path	True	string (uuid)	基本モデルの識別子。

応答

名前	型	説明
200 OK	BaseModel	わかりました
Other Status Codes	Error	エラーが発生しました。

セキュリティ

Ocp-Apim-Subscription-Key

コグニティブサービスアカウントキーをここで指定します。

型: apiKey
/: header

Authorization

このリージョンの STS によって返される JWT からアクセストークンを指定します。 STS URL に次のクエリ文字列を追加して、トークンに管理スコープを追加してください: ?scope=speechservicesmanagement

型: apiKey
/: header

例

Get a base model

要求のサンプル

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b

応答のサンプル

状態コード:: 200

{
  "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
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	このモデルを音声コンテナーの文字起こしに使用できるかどうかを示す値。この機能は、音声コンテナーで使用できるようになると、既存のモデルに追加できます。

BaseModelLinks

Object

BaseModelLinks

名前	型	説明
manifest	string (uri)	オンプレミスコンテナーで使用されるこのモデルのマニフェストを取得する場所。詳細については、操作 "Models_GetCustomModelManifest" を参照してください。

BaseModelProperties

Object

BaseModelProperties

名前	型	説明
chargeForAdaptation	boolean	モデル適応が課金されるかどうかを示す値。
deprecationDates	BaseModelDeprecationDates	BaseModelDeprecationDates
features	BaseModelFeatures	BaseModelFeatures モデルでサポートされている機能。

DatasetKind

列挙

DatasetKind

値	説明
Acoustic	音響データセット。
AudioFiles	オーディオファイルデータセット。
Language	言語データセット。
LanguageMarkdown	言語マークダウンデータセット。
OutputFormatting	逆テキスト正規化、大文字と小文字の変換、再入力、不適切な表現をカスタマイズするルールを含むデータセット。また、データセット検証のテストも定義します
Pronunciation	発音データセット。

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	ログのスキップトークンが無効です。
InvalidSourceAzureResourceId	ソース Azure リソース ID が無効です。
InvalidSubscription	サブスクリプションが無効です。
InvalidTest	テストが無効です。
InvalidTimeToLive	有効期限が無効です。
InvalidTopForLogs	ログの top が無効です。
InvalidTranscription	文字起こしが無効です。
InvalidWebHookEventKind	Web フックイベントの種類が無効です。
MissingInputRecords	入力レコードがありません。
ModelCopyOperationExists	モデルのコピー操作が存在します。
ModelDeploymentNotCompleteState	モデルのデプロイが完了していない状態です。
ModelDeprecated	モデルは非推奨になりました。
ModelExists	モデルが存在します。
ModelMismatch	モデルの不一致。
ModelNotDeployable	モデルはデプロイできません。
ModelVersionIncorrect	モデルのバージョンが正しくありません。
NoUtf8WithBom	bom を含む utf8 はありません。
OnlyOneOfUrlsOrContainerOrDataset	URL またはコンテナーまたはデータセットのいずれか 1 つだけ。
ProjectGenderMismatch	プロジェクトの性別の不一致。
QuotaViolation	クォータ違反。
SingleDefaultEndpoint	単一の既定のエンドポイント。
SkuLimitsExist	SKU の制限が存在します。
SubscriptionNotFound	サブスクリプションが見つかりません。
UnexpectedError	予期しないエラー。
UnsupportedClassBasedAdaptation	サポートされていないクラスベースの適応。
UnsupportedDelta	サポートされていないデルタ。
UnsupportedDynamicConfiguration	サポートされていない動的構成。
UnsupportedFilter	サポートされていないフィルター。
UnsupportedLanguageCode	サポートされていない言語コード。
UnsupportedOrderBy	サポートされていない注文者。
UnsupportedPagination	サポートされていない改ページ位置。
UnsupportedTimeRange	サポートされていない時間範囲。

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

列挙

エラーコード

値	説明
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 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

値	説明
Display	モデルでは、文字起こしの出力またはエンドポイントの表示書式設定がサポートされています。
Lexical	モデルは、書式設定なしで文字起こし出力を提供します。

Status

列挙

ステータス

値	説明
Failed	実行時間の長い操作が失敗しました。
NotStarted	実行時間の長い操作がまだ開始されていません。
Running	実行時間の長い操作は現在処理中です。
Succeeded	実行時間の長い操作が正常に完了しました。

次の方法で共有

Models - Get Base Model

URI パラメーター

応答

セキュリティ

Ocp-Apim-Subscription-Key

Authorization

例

Get a base model

要求のサンプル

応答のサンプル

定義

BaseModel

BaseModelDeprecationDates

BaseModelFeatures

BaseModelLinks

BaseModelProperties

DatasetKind

DetailedErrorCode

Error

ErrorCode

InnerError

OutputFormatType

Status

その他のリソース