次の方法で共有


Models - Update

指定した ID によって識別されるモデルのメタデータをUpdatesします。

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

URI パラメーター

名前 / 必須 説明
endpoint
path True

string

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

id
path True

string

uuid

モデルの識別子。

要求本文

Media Types: "application/json", "application/merge-patch+json"

名前 説明
customProperties

object

このエンティティのカスタム プロパティ。 許可されるキーの最大長は 64 文字、最大許容値の長さは 256 文字、許可されるエントリの数は 10 です。

description

string

オブジェクトの説明。

displayName

string

オブジェクトの名前。

project

EntityReference

EntityReference

応答

名前 説明
200 OK

CustomModel

OK

ヘッダー

Retry-After: integer

Other Status Codes

Error

エラーが発生しました。

セキュリティ

Ocp-Apim-Subscription-Key

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

型: apiKey
/: header

Authorization

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

型: apiKey
/: header

Update a model

要求のサンプル

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

{
  "displayName": "Language model update",
  "description": "This is a language model update",
  "customProperties": {
    "key": "value"
  }
}

応答のサンプル

{
  "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"
}

定義

名前 説明
CustomModel

CustomModel

CustomModelDeprecationDates

CustomModelDeprecationDates

CustomModelFeatures

CustomModelFeatures

CustomModelLinks

CustomModelLinks

CustomModelProperties

CustomModelProperties

DetailedErrorCode

DetailedErrorCode

EntityError

EntityError

EntityReference

EntityReference

Error

エラー

ErrorCode

ErrorCode

InnerError

InnerError

ModelUpdate

ModelUpdate

OutputFormatType

OutputFormatType

Status

Status

CustomModel

CustomModel

名前 説明
baseModel

EntityReference

EntityReference

createdDateTime

string

オブジェクトが作成されたときのタイムスタンプ。 タイム スタンプは、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

オブジェクトの表示名。

lastActionDateTime

string

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

links

CustomModelLinks

CustomModelLinks

locale

string

包含データのロケール。

project

EntityReference

EntityReference

properties

CustomModelProperties

CustomModelProperties

self

string

このエンティティの場所。

status

Status

Status
API の現在の状態について説明する

text

string

この言語モデルの適応に使用されるテキスト。

CustomModelDeprecationDates

CustomModelDeprecationDates

名前 説明
transcriptionDateTime

string

文字起こしが非推奨になる日付。

CustomModelFeatures

CustomModelFeatures

名前 説明
supportedOutputFormats

OutputFormatType[]

サポートされている出力形式。

supportsEndpoints

boolean

ライブ文字起こしのエンドポイントの作成がサポートされているかどうかを示す値。

supportsTranscriptions

boolean

バッチ文字起こしがサポートされているかどうかを示す値。

supportsTranscriptionsOnSpeechContainers

boolean

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

CustomModelLinks

名前 説明
copy

string

モデル コピー アクションの場所。 詳細については、操作 "Models_Copy" を参照してください。

copyTo

string

古いモデル コピー アクションの場所。 詳細については、操作 "Models_CopyTo" を参照してください。

files

string

このエンティティのすべてのファイルを取得する場所。 詳細については、操作 "Models_ListFiles" を参照してください。

manifest

string

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

CustomModelProperties

CustomModelProperties

名前 説明
customModelWeightPercent

integer

1 (1% カスタム モデルと 99% ベース モデル) から 100 (100% カスタム モデルと 0% ベース モデル) の間のカスタム モデルの重み。 このプロパティが設定されていない場合、サービスは適切な値を選択します (選択した重みを取得するモデルを取得します)。 このプロパティを使用せずに開始します。 必要に応じて、より大きい (または小さい) 重みを選択して、カスタム モデルの影響を増減します。

deprecationDates

CustomModelDeprecationDates

CustomModelDeprecationDates

email

string

操作が完了した場合に電子メール通知を送信する電子メール アドレス。 値は、電子メールを正常に送信した後に削除されます。

error

EntityError

EntityError

features

CustomModelFeatures

CustomModelFeatures
モデルでサポートされている機能。

DetailedErrorCode

DetailedErrorCode

名前 説明
DataImportFailed

string

データのインポートに失敗しました。

DeleteNotAllowed

string

削除は許可されません。

DeployNotAllowed

string

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

DeployingFailedModel

string

失敗したモデルのデプロイ。

EmptyRequest

string

空の要求。

EndpointCannotBeDefault

string

エンドポイントを既定にすることはできません。

EndpointNotUpdatable

string

エンドポイントは更新できません。

EndpointWithoutLogging

string

ログを記録しないエンドポイント。

ExceededNumberOfRecordingsUris

string

記録 URI の数を超えました。

FailedDataset

string

失敗したデータセット。

Forbidden

string

Forbidden.

InUseViolation

string

使用中の違反。

InaccessibleCustomerStorage

string

アクセスできない顧客ストレージ。

InvalidAdaptationMapping

string

適応マッピングが無効です。

InvalidBaseModel

string

ベース モデルが無効です。

InvalidCallbackUri

string

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

InvalidCollection

string

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

InvalidDataset

string

データセットが無効です。

InvalidDocument

string

ドキュメントが無効です。

InvalidDocumentBatch

string

ドキュメント バッチが無効です。

InvalidLocale

string

ロケールが無効です。

InvalidLogDate

string

ログの日付が無効です。

InvalidLogEndTime

string

ログの終了時刻が無効です。

InvalidLogId

string

ログ ID が無効です。

InvalidLogStartTime

string

ログの開始時刻が無効です。

InvalidModel

string

モデルが無効です。

InvalidModelUri

string

モデル URI が無効です。

InvalidParameter

string

無効なパラメーター。

InvalidParameterValue

string

パラメーターの値が無効です。

InvalidPayload

string

ペイロードが無効です。

InvalidPermissions

string

アクセス許可が無効です。

InvalidPrerequisite

string

前提条件が正しくありません。

InvalidProductId

string

製品 ID が無効です。

InvalidProject

string

プロジェクトが無効です。

InvalidProjectKind

string

プロジェクトの種類が無効です。

InvalidRecordingsUri

string

無効な記録 URI。

InvalidRequestBodyFormat

string

要求本文の形式が無効です。

InvalidSasValidityDuration

string

sas の有効期間が無効です。

InvalidSkipTokenForLogs

string

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

InvalidSourceAzureResourceId

string

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

InvalidSubscription

string

サブスクリプションが無効です。

InvalidTest

string

テストが無効です。

InvalidTimeToLive

string

有効期間が無効です。

InvalidTopForLogs

string

ログの top が無効です。

InvalidTranscription

string

文字起こしが無効です。

InvalidWebHookEventKind

string

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

MissingInputRecords

string

入力レコードがありません。

ModelCopyOperationExists

string

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

ModelDeploymentNotCompleteState

string

モデルのデプロイが完了していない状態です。

ModelDeprecated

string

モデルは非推奨になりました。

ModelExists

string

モデルが存在します。

ModelMismatch

string

モデルの不一致。

ModelNotDeployable

string

モデルはデプロイできません。

ModelVersionIncorrect

string

モデル のバージョンが正しくありません。

NoUtf8WithBom

string

bom を含む utf8 はありません。

OnlyOneOfUrlsOrContainerOrDataset

string

URL またはコンテナーまたはデータセットの 1 つだけ。

ProjectGenderMismatch

string

プロジェクトの性別の不一致。

QuotaViolation

string

クォータ違反。

SingleDefaultEndpoint

string

単一の既定のエンドポイント。

SkuLimitsExist

string

SKU の制限が存在します。

SubscriptionNotFound

string

サブスクリプションが見つかりません。

UnexpectedError

string

予期しないエラー。

UnsupportedClassBasedAdaptation

string

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

UnsupportedDelta

string

サポートされていないデルタ。

UnsupportedDynamicConfiguration

string

サポートされていない動的構成。

UnsupportedFilter

string

サポートされていないフィルター。

UnsupportedLanguageCode

string

サポートされていない言語コード。

UnsupportedOrderBy

string

サポートされていない順序。

UnsupportedPagination

string

サポートされていない改ページ位置。

UnsupportedTimeRange

string

サポートされていない時間範囲。

EntityError

EntityError

名前 説明
code

string

このエラーのコード。

message

string

このエラーのメッセージ。

EntityReference

EntityReference

名前 説明
self

string

参照先エンティティの場所。

Error

エラー

名前 説明
code

ErrorCode

ErrorCode
高レベルのエラー コード。

details

Error[]

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

innerError

InnerError

InnerError
で入手できる https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owCognitive Services API ガイドラインに準拠した新しい内部エラー形式。 必須プロパティとして ErrorCode、message、省略可能プロパティとして target、details (キーと値のペア)、inner error (入れ子が可能) が含まれています。

message

string

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

target

string

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

ErrorCode

ErrorCode

名前 説明
Conflict

string

競合エラー コードを表します。

Forbidden

string

禁止されているエラー コードを表します。

InternalCommunicationFailed

string

内部通信に失敗したエラー コードを表します。

InternalServerError

string

内部サーバー エラー コードを表します。

InvalidArgument

string

無効な引数エラー コードを表します。

InvalidRequest

string

無効な要求エラー コードを表します。

NotAllowed

string

許可されていないエラー コードを表します。

NotFound

string

見つからないエラー コードを表します。

PipelineError

string

パイプライン エラー のエラー コードを表します。

ServiceUnavailable

string

サービスを使用できないエラー コードを表します。

TooManyRequests

string

要求の数が多すぎるエラー コードを表します。

Unauthorized

string

未承認のエラー コードを表します。

UnprocessableEntity

string

処理不可能なエンティティ エラー コードを表します。

UnsupportedMediaType

string

サポートされていないメディアの種類のエラー コードを表します。

InnerError

InnerError

名前 説明
code

DetailedErrorCode

DetailedErrorCode
詳細なエラー コード列挙型。

details

object

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

innerError

InnerError

InnerError
で入手できる https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owCognitive Services API ガイドラインに準拠した新しい内部エラー形式。 必須プロパティとして ErrorCode、message、省略可能プロパティとして target、details (キーと値のペア)、inner error (入れ子が可能) が含まれています。

message

string

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

target

string

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

ModelUpdate

ModelUpdate

名前 説明
customProperties

object

このエンティティのカスタム プロパティ。 許可されるキーの最大長は 64 文字、最大許容値の長さは 256 文字、許可されるエントリの数は 10 です。

description

string

オブジェクトの説明。

displayName

string

オブジェクトの名前。

project

EntityReference

EntityReference

OutputFormatType

OutputFormatType

名前 説明
Display

string

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

Lexical

string

Model では、書式設定なしで文字起こし出力が提供されます。

Status

Status

名前 説明
Failed

string

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

NotStarted

string

実行時間の長い操作はまだ開始されていません。

Running

string

実行時間の長い操作は現在処理中です。

Succeeded

string

実行時間の長い操作が正常に完了しました。