Models - Get

  • リファレンス
サービス:
Azure AI Services
API バージョン:
2024-02-01-preview

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

GET {endpoint}/customvoice/models/{id}?api-version=2024-02-01-preview

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://eastus.api.cognitive.microsoft.com
id
 path True

string

リソースの ID。

正規表現パターン: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
api-version
 query True

string

この操作に使用する API バージョン。

要求ヘッダー

名前 必須 型 説明
Ocp-Apim-Subscription-Key True

string

Speech リソース キーをここに入力します。

応答

名前 型 説明
200 OK

Model

Success
Other Status Codes

ErrorResponse

エラーが発生しました。

ヘッダー

x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

Speech リソース キーをここに入力します。

型: apiKey
/: header

例

Get a model

要求のサンプル

GET {endpoint}/customvoice/models/Jessica?api-version=2024-02-01-preview

応答のサンプル

状態コード:
200 
{
  "id": "Jessica",
  "voiceName": "JessicaNeural",
  "description": "Jessica voice",
  "recipe": {
    "kind": "Default",
    "version": "V7.2023.03"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "engineVersion": "2023.07.04.0",
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

定義

名前 説明
Error

最上位レベルのエラーは、 で利用可能な Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、エラー コード、メッセージ、詳細、ターゲット、およびよりわかりやすい詳細を含む内部エラーを含む最上位レベルのエラーが含まれます。
ErrorCode

最上位のエラー コード
ErrorResponse

エラー応答は、 で入手できる Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。
InnerError

内部エラーは、 で入手できる Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、必須プロパティのエラー コード、メッセージ、およびオプションのプロパティ ターゲット、内部エラー (入れ子にできます) が含まれます。
Model

モデル オブジェクト
ModelFailureReason

モデル トレーニングの失敗の理由
ModelProperties

モデルのプロパティ
PresetStyleItem

レシピでサポートされているプリセット スタイル。 音声モデルでは、スタイル トレーニング セットなしでこれらのスタイルをサポートできます。
Recipe

モデル構築のレシピ。 レシピによって機能が異なります。
Status

リソースの状態。

Error

最上位レベルのエラーは、 で利用可能な Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、エラー コード、メッセージ、詳細、ターゲット、およびよりわかりやすい詳細を含む内部エラーを含む最上位レベルのエラーが含まれます。

名前 型 説明
code

ErrorCode

最上位のエラー コード
details

Error[]

エラーや予想されるポリシーに関する追加のサポートの詳細。
innererror

InnerError

内部エラーは、 で入手できる Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、必須プロパティのエラー コード、メッセージ、およびオプションのプロパティ ターゲット、内部エラー (入れ子にできます) が含まれます。
message

string

最上位レベルのエラー メッセージ。
target

string

エラーのソースです。 たとえば、無効なモデルの場合は、"model" または "model id" になります。

ErrorCode

最上位のエラー コード

名前 型 説明
BadArgument

string

BadRequest

string

Forbidden

string

InternalServerError

string

NotFound

string

ServiceUnavailable

string

TooManyRequests

string

Unauthorized

string

UnsupportedMediaType

string

ErrorResponse

エラー応答は、 で入手できる Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。

名前 型 説明
error

Error

最上位レベルのエラーは、 で利用可能な Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、エラー コード、メッセージ、詳細、ターゲット、およびよりわかりやすい詳細を含む内部エラーを含む最上位レベルのエラーが含まれます。

InnerError

内部エラーは、 で入手できる Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、必須プロパティのエラー コード、メッセージ、およびオプションのプロパティ ターゲット、内部エラー (入れ子にできます) が含まれます。

名前 型 説明
code

string

診断に役立つ詳細なエラー コード。
innererror

InnerError

内部エラーは、 で入手できる Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、必須プロパティのエラー コード、メッセージ、およびオプションのプロパティ ターゲット、内部エラー (入れ子にできます) が含まれます。
message

string

詳細なエラー メッセージ。
target

string

エラーのソースです。 たとえば、無効なモデルの場合は、"model" または "model id" になります。

Model

モデル オブジェクト

名前 型 説明
consentId

string

リソースの ID
createdDateTime

string

オブジェクトが作成されたときのタイムスタンプ。 タイムスタンプは ISO 8601 日時形式 ("YYYY-MM-DDThh:mm:ssZ"、 を参照) https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representationsとしてエンコードされます。
description

string

モデルの説明
engineVersion

string

エンジンのバージョン。 このバージョンを更新すると、最新の発音バグ修正を取得できます。
id

string

リソースの ID
lastActionDateTime

string

現在の状態が入力されたときのタイムスタンプ。 タイムスタンプは ISO 8601 日時形式 ("YYYY-MM-DDThh:mm:ssZ"、 を参照) https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representationsとしてエンコードされます。
locale

string

このモデルのロケール。 ロケール コードは BCP-47 に従います。 テキスト読み上げロケールの一覧については、こちらを参照してください https://video2.skills-academy.com/azure/ai-services/speech-service/language-support?tabs=tts。
projectId

string

リソースの ID
properties

ModelProperties

モデルのプロパティ
recipe

Recipe

モデル構築のレシピ。 レシピによって機能が異なります。
status

Status

リソースの状態。
trainingSetId

string

リソースの ID
voiceName

string

音声名

ModelFailureReason

モデル トレーニングの失敗の理由

名前 型 説明
InaccessibleCustomerStorage

string

顧客は、Speech アカウントで Bring Your Own Storage を使用します。 ただし、ストレージにはアクセスできません。 ドキュメントを確認してください。
Internal

string

Custom Voice Service エラー。
SpeakerVerificationFailed

string

同意とトレーニング オーディオは、同じ話者からのものではありません。
TerminateByUser

string

顧客がモデル トレーニングを取り消しました。

ModelProperties

モデルのプロパティ

名前 型 説明
failureReason

ModelFailureReason

モデル トレーニングの失敗の理由
presetStyles

string[]

このモデルのプリセット スタイル。
styleTrainingSetIds

object

カスタマイズされたスタイルと関連するトレーニング セット。
voiceStyles

string[]

このモデルでサポートされているすべてのスタイル。

PresetStyleItem

レシピでサポートされているプリセット スタイル。 音声モデルでは、スタイル トレーニング セットなしでこれらのスタイルをサポートできます。

名前 型 説明
female

string[]

女性の音声モデルでサポートされているプリセット スタイル。
male

string[]

男性の音声モデルでサポートされているプリセット スタイル。

Recipe

モデル構築のレシピ。 レシピによって機能が異なります。

名前 型 説明
datasetLocales

string[]

トレーニング データセットのロケール。 ロケール コードは BCP-47 に従います。 テキスト読み上げロケールの一覧については、こちらを参照してください https://video2.skills-academy.com/azure/ai-services/speech-service/language-support?tabs=tts。
description

string

レシピの説明
kind

string

レシピの種類
maxCustomStyleNum

integer

1 つの音声モデルでサポートされる、カスタマイズされた最大スタイル番号。
minStyleUtteranceCount

integer

カスタマイズされた各スタイルをトレーニングするために必要な最小発話数。
minUtteranceCount

integer

このレシピを使用して音声モデルをトレーニングするために必要な最小発話数。
modelLocales

string[]

音声モデルがこのレシピで話すことができるロケール。 ロケール コードは BCP-47 に従います。 テキスト読み上げロケールの一覧については、こちらを参照してください https://video2.skills-academy.com/azure/ai-services/speech-service/language-support?tabs=tts。
presetStyles

<string,  PresetStyleItem>

ロケールごとにこのレシピでサポートされているプリセット スタイル。 これらのスタイルは、スタイル トレーニング セットなしで取得できます。
version

string

レシピバージョン

Status

リソースの状態。

名前 型 説明
Disabled

string

Disabling

string

Failed

string

NotStarted

string

Running

string

Succeeded

string