Models - Create

サービス:

Azure AI Services

API バージョン:

v3.2-preview.2

新しいモデルを作成します。

POST {endpoint}/speechtotext/v3.2-preview.2/models

URI パラメーター

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

要求本文

名前	必須	型	説明
displayName	True	string minLength: 1	オブジェクトの表示名。
locale	True	string minLength: 1	格納されているデータのロケール。
baseModel		EntityReference	EntityReference
customProperties		object	このエンティティのカスタム プロパティ。 許可されるキーの最大長は 64 文字、最大許容値の長さは 256 文字、許可されるエントリの数は 10 です。
datasets		EntityReference[]	適応に使用されるデータセット。
description		string	オブジェクトの説明。
project		EntityReference	EntityReference
properties		CustomModelProperties	CustomModelProperties
text		string	この言語モデルの適応に使用されるテキスト。

応答

名前	型	説明
201 Created	CustomModel	応答には、ペイロードとしてのエンティティとその場所に関する情報がヘッダーとして含まれます。 ヘッダー Location: string
Other Status Codes	Error	エラーが発生しました。

セキュリティ

Ocp-Apim-Subscription-Key

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

型: apiKey
/: header

Authorization

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

型: apiKey
/: header

例

Create a model

Create a model with custom model weight

Create a model

要求のサンプル

HTTP

POST {endpoint}/speechtotext/v3.2-preview.2/models

{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "locale": "en-US",
  "displayName": "Model with acoustic and language datasets"
}

応答のサンプル

状態コード:

201

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b",
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
    "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
    "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
  },
  "properties": {
    "deprecationDates": {
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "customModelWeightPercent": 30,
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": false,
      "supportedOutputFormats": [
        "Lexical",
        "Display"
      ]
    }
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Running",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Language model",
  "description": "This is a language model"
}

Create a model with custom model weight

要求のサンプル

HTTP

POST {endpoint}/speechtotext/v3.2-preview.2/models

{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "properties": {
    "customModelWeightPercent": 42
  },
  "locale": "en-US",
  "displayName": "Model with acoustic and language datasets"
}

応答のサンプル

状態コード:

201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b",
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
    "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
    "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
  },
  "properties": {
    "deprecationDates": {
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "customModelWeightPercent": 42,
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": false,
      "supportedOutputFormats": [
        "Lexical",
        "Display"
      ]
    }
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Running",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Language model",
  "description": "This is a language model"
}

定義

名前	説明
CustomModel	CustomModel
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	エラー
ErrorCode	エラーコード
InnerError	InnerError
OutputFormatType	OutputFormatType
Status	ステータス

CustomModel

Object

CustomModel

名前	型	説明
baseModel	EntityReference	EntityReference
createdDateTime	string (date-time)	オブジェクトが作成されたときのタイムスタンプ。 タイムスタンプは ISO 8601 の日付と時刻の形式 ("YYYY-MM-DDThh:mm:ssZ"、 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations参照) としてエンコードされます。
customProperties	object	このエンティティのカスタム プロパティ。 許可されるキーの最大長は 64 文字、最大許容値の長さは 256 文字、許可されるエントリの数は 10 です。
datasets	EntityReference[]	適応に使用されるデータセット。
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	CustomModelLinks	CustomModelLinks
locale	string minLength: 1	格納されているデータのロケール。
project	EntityReference	EntityReference
properties	CustomModelProperties	CustomModelProperties
self	string (uri)	このエンティティの場所。
status	Status	ステータス API の現在の状態について説明する
text	string	この言語モデルの適応に使用されるテキスト。

CustomModelDeprecationDates

Object

CustomModelDeprecationDates

名前	型	説明
transcriptionDateTime	string (date-time)	文字起こしが非推奨になる日付。

CustomModelFeatures

Object

CustomModelFeatures

名前	型	説明
supportedOutputFormats	OutputFormatType[]	サポートされている出力形式。
supportsEndpoints	boolean	ライブ文字起こしのエンドポイントの作成がサポートされているかどうかを示す値。
supportsTranscriptions	boolean	バッチ文字起こしがサポートされているかどうかを示す値。
supportsTranscriptionsOnSpeechContainers	boolean	このモデルを音声コンテナーの文字起こしに使用できるかどうかを示す値。 この機能は、音声コンテナーで使用できるようになると、既存のモデルに追加できます。

CustomModelLinks

Object

CustomModelLinks

名前	型	説明
copy	string (uri)	モデル コピー アクションの場所。 詳細については、操作 "Models_Copy" を参照してください。
copyTo	string (uri)	古いモデル コピー アクションの場所。 詳細については、操作 "Models_CopyTo" を参照してください。
files	string (uri)	このエンティティのすべてのファイルを取得する場所。 詳細については、操作 "Models_ListFiles" を参照してください。
manifest	string (uri)	オンプレミス コンテナーで使用されるこのモデルのマニフェストを取得する場所。 詳細については、操作 "Models_GetCustomModelManifest" を参照してください。

CustomModelProperties

Object

CustomModelProperties

名前	型	説明
customModelWeightPercent	integer (int32) minimum: 1 maximum: 100	1 (1% カスタム モデルと 99% 基本モデル) から 100 (カスタム モデル 100% 0% 基本モデル) のカスタム モデルの重み。 このプロパティが設定されていない場合、サービスは適切な値を選択します (選択した重みを取得するモデルを取得します)。 このプロパティを使用せずに開始します。 必要に応じて、より大きい (または小さい) 重みを選択して、カスタム モデルの影響を増減します。
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
email	string	操作が完了した場合に電子メール通知を送信する電子メール アドレス。 この値は、電子メールを正常に送信した後に削除されます。
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures モデルでサポートされている機能。

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	サポートされていない時間範囲。

EntityError

Object

EntityError

名前	型	説明
code	string	このエラーのコード。
message	string	このエラーのメッセージ。

EntityReference

Object

EntityReference

名前	型	説明
self	string (uri)	参照先エンティティの場所。

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	実行時間の長い操作が正常に完了しました。