次の方法で共有


Transcriptions - Update

ID によって示された文字起こしの変更可能な詳細を更新する。

PATCH {endpoint}/speechtotext/v3.2-preview.2/transcriptions/{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

Transcription

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 transcription

要求のサンプル

PATCH {endpoint}/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683

{
  "displayName": "Updated transcription name",
  "description": "Updated transcription description",
  "customProperties": {
    "key": "value"
  }
}

応答のサンプル

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
  },
  "properties": {
    "diarizationEnabled": false,
    "wordLevelTimestampsEnabled": false,
    "displayFormWordLevelTimestampsEnabled": false,
    "channels": [
      0,
      1
    ],
    "punctuationMode": "DictatedAndAutomatic",
    "profanityFilterMode": "Masked",
    "duration": "PT42S"
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Transcription using adapted model en-US",
  "customProperties": {
    "key": "value"
  }
}

定義

名前 説明
DetailedErrorCode

DetailedErrorCode

DiarizationProperties

DiarizationProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

EntityError

EntityError

EntityReference

EntityReference

Error

エラー

ErrorCode

ErrorCode

InnerError

InnerError

LanguageIdentificationMode

LanguageIdentificationMode

LanguageIdentificationProperties

LanguageIdentificationProperties

ProfanityFilterMode

ProfanityFilterMode

PunctuationMode

PunctuationMode

Status

Status

Transcription

文字起こし

TranscriptionLinks

TranscriptionLinks

TranscriptionProperties

TranscriptionProperties

TranscriptionUpdate

TranscriptionUpdate

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

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

DiarizationProperties

DiarizationProperties

名前 説明
speakers

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

名前 説明
maxCount

integer

ダイアライゼーション用のスピーカーの最大数。 36 未満で、minSpeakers プロパティ以上である必要があります。

minCount

integer

ダイアライゼーション用のスピーカーの最小数のヒント。 maxSpeakers プロパティ以下である必要があります。

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" になります。

LanguageIdentificationMode

LanguageIdentificationMode

名前 説明
Continuous

string

継続的な言語識別 (既定値)。

Single

string

単一言語の識別。

LanguageIdentificationProperties

LanguageIdentificationProperties

名前 規定値 説明
candidateLocales

string[]

言語識別の候補ロケール (["en-US"、"de-DE"、"es-ES"] など)。 文字起こし用のメイン ロケールを含め、最小 2 個から最大 10 個の候補ロケールがサポートされています。

mode

LanguageIdentificationMode

Continuous

LanguageIdentificationMode
言語識別に使用されるモード。

speechModelMapping

<string,  EntityReference>

音声モデル エンティティへのロケールの省略可能なマッピング。 ロケールにモデルが指定されていない場合は、既定の基本モデルが使用されます。 キーは候補ロケールに含まれるロケールである必要があります。値は、それぞれのロケールのモデルのエンティティです。

ProfanityFilterMode

ProfanityFilterMode

名前 説明
Masked

string

最初の文字 (f*** など) を除く * で不適切な表現をマスクする

None

string

不適切なフィルター処理を無効にします。

Removed

string

不適切な表現を削除します。

Tags

string

"不適切な表現" XML タグ</不適切な表現を追加する>

PunctuationMode

PunctuationMode

名前 説明
Automatic

string

自動句読点。

Dictated

string

ディクテーションされた句読点のみ、つまり明示的な句読点です。

DictatedAndAutomatic

string

ディクテーションされた句読点または自動句読点。

None

string

句読点なし。

Status

Status

名前 説明
Failed

string

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

NotStarted

string

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

Running

string

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

Succeeded

string

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

Transcription

文字起こし

名前 説明
contentContainerUrl

string

オーディオ ファイルを含む Azure BLOB コンテナーの URL。 コンテナーの最大サイズは 5 GB、BLOB の最大数は 1,0000 です。 BLOB の最大サイズは 2.5 GB です。 コンテナー SAS には、'r' (読み取り) と 'l' (リスト) のアクセス許可が含まれている必要があります。 このプロパティは応答では返されません。

contentUrls

string[]

文字起こしするオーディオ ファイルを取得するコンテンツ URL の一覧。 最大 1,000 個の URL を使用できます。 このプロパティは応答では返されません。

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 です。

dataset

EntityReference

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

TranscriptionLinks

TranscriptionLinks

locale

string

格納されているデータのロケール。 言語識別が使用されている場合、このロケールは、言語が検出できなかった音声を文字起こしするために使用されます。

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

TranscriptionProperties

TranscriptionProperties

self

string

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

status

Status

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

TranscriptionLinks

名前 説明
files

string

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

TranscriptionProperties

TranscriptionProperties

名前 説明
channels

integer[]

要求されたチャネル番号のコレクション。 既定では、チャネル 0 とチャネル 1 が考慮されます。

destinationContainerUrl

string

要求された宛先コンテナー。

注釈

変換先コンテナーを と timeToLive組み合わせて使用すると、文字起こしのメタデータは通常どおりに削除されますが、このコンテナーに対する削除アクセス許可は必要ないため、変換先コンテナーに格納されているデータ (文字起こしの結果を含む) は変更されません。
自動クリーンアップをサポートするには、コンテナーで BLOB の有効期間を構成するか、 の代わりに destinationContainerUrl"Bring Your Own Storage (BYOS)" を使用します。ここで、BLOB をクリーンアップできます。

diarization

DiarizationProperties

DiarizationProperties

diarizationEnabled

boolean

ダイアライゼーション (話者識別) が要求されるかどうかを示す値。 既定値は false です。 このフィールドを true に設定し、 を指定して改善された diarization システムを DiarizationProperties構成した場合、改善された diarization システムは、構成可能なスピーカーの範囲に対して diarization を提供します。 このフィールドが true に設定されていて、改善されたダイアライゼーション システムが有効になっていない (指定 DiarizationPropertiesしない) 場合、基本的なダイアライゼーション システムは最大 2 つのスピーカーを区別します。 基本的なダイアライズには追加料金は適用されません。

基本的な diarization システムは非推奨となり、次のメジャー バージョンの API で削除されます。 この diarizationEnabled 設定も削除されます。

displayFormWordLevelTimestampsEnabled

boolean

表示フォームの単語レベルのタイムスタンプが要求されるかどうかを示す値。 既定値は false です。

duration

string

文字起こしの期間。 期間は ISO 8601 期間としてエンコードされます (「PnYnMnDTnHnMnS」を参照)。https://en.wikipedia.org/wiki/ISO_8601#Durations

email

string

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

error

EntityError

EntityError

languageIdentification

LanguageIdentificationProperties

LanguageIdentificationProperties

profanityFilterMode

ProfanityFilterMode

ProfanityFilterMode
不適切な表現のフィルター処理のモード。

punctuationMode

PunctuationMode

PunctuationMode
句読点に使用されるモード。

timeToLive

string

文字起こしが完了した後にシステムに保持される期間。 文字起こしが完了 (成功または失敗) した後の有効期間に達すると、自動的に削除されます。 この値を設定しないか、0 に設定すると、自動削除が無効になります。 サポートされている最も長い期間は 31 日です。 期間は ISO 8601 期間としてエンコードされます (「PnYnMnDTnHnMnS」を参照)。https://en.wikipedia.org/wiki/ISO_8601#Durations

wordLevelTimestampsEnabled

boolean

単語レベルのタイムスタンプが要求されるかどうかを示す値。 既定値は false です。

TranscriptionUpdate

TranscriptionUpdate

名前 説明
customProperties

object

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

description

string

オブジェクトの説明。

displayName

string

オブジェクトの名前。

project

EntityReference

EntityReference