StartCallAnalyticsStreamTranscription

双方向 HTTP/2 WebSocket ストリームをスタートし、オーディオが Amazon Transcribe にストリーミングされると、文字起こしの結果がアプリケーションにストリーミングされます。この操作は、コールアナリティクスのトランスクリプションに使用してください。

以下のパラメータは必須です。

• language-code

• media-encoding

• sample-rate

Amazon Transcribe でのストリーミングの詳細については、ストリーミング音声の文字起こしをを参照してください。

リクエストの構文

POST /call-analytics-stream-transcription HTTP/2
x-amzn-transcribe-language-code: LanguageCode
x-amzn-transcribe-sample-rate: MediaSampleRateHertz
x-amzn-transcribe-media-encoding: MediaEncoding
x-amzn-transcribe-vocabulary-name: VocabularyName
x-amzn-transcribe-session-id: SessionId
x-amzn-transcribe-vocabulary-filter-name: VocabularyFilterName
x-amzn-transcribe-vocabulary-filter-method: VocabularyFilterMethod
x-amzn-transcribe-language-model-name: LanguageModelName
x-amzn-transcribe-enable-partial-results-stabilization: EnablePartialResultsStabilization
x-amzn-transcribe-partial-results-stability: PartialResultsStability
x-amzn-transcribe-content-identification-type: ContentIdentificationType
x-amzn-transcribe-content-redaction-type: ContentRedactionType
x-amzn-transcribe-pii-entity-types: PiiEntityTypes
Content-type: application/json

{
   "AudioStream": { 
      "AudioEvent": { 
         "AudioChunk": blob
      },
      "ConfigurationEvent": { 
         "ChannelDefinitions": [ 
            { 
               "ChannelId": number,
               "ParticipantRole": "string"
            }
         ],
         "PostCallAnalyticsSettings": { 
            "ContentRedactionOutput": "string",
            "DataAccessRoleArn": "string",
            "OutputEncryptionKMSKeyId": "string",
            "OutputLocation": "string"
         }
      }
   }
}

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

ContentIdentificationType

記録で識別されるすべての個人を特定できる情報 (PII) にラベルを付けます。

コンテンツの識別はセグメントレベルで行われ、PiiEntityTypesで指定された個人情報は、音声セグメントの文字起こしが完了するとフラグが付けられます。

ContentIdentificationTypeContentRedactionType同じリクエストでとを設定することはできません。両方を設定した場合、リクエストは BadRequestException を返します。

詳細については、「個人を特定できる情報の編集または識別」を参照してください。

有効な値: PII

ContentRedactionType

記録で特定される個人を特定できる情報 (PII) をすべて編集します。

コンテンツの編集はセグメントレベルで実行されます。PiiEntityTypesで指定された個人情報は、オーディオセグメントの文字起こしが完了すると編集されます。

ContentRedactionTypeContentIdentificationType同じリクエストでとを設定することはできません。両方を設定した場合、リクエストは BadRequestException を返します。

詳細については、「個人を特定できる情報の編集または識別」を参照してください。

有効な値: PII

EnablePartialResultsStabilization

トランスクリプションの結果を部分的に安定化できます。結果を部分的に安定させることで、出力のレイテンシーを減らすことができますが、精度に影響する可能性があります。詳細については、部分結果安定化を参照してください。

LanguageCode

音声で話されている言語を表す言語コードを指定します。

オーディオで話されている言語が不明な場合は、IdentifyLanguageを使用して自動言語識別を有効にすることを検討してください。

リアルタイムコールアナリティクスでサポートされている言語のリストについては、「サポートされている言語」の表を参照してください。

有効な値: en-US | en-GB | es-US | fr-CA | fr-FR | en-AU | it-IT | de-DE | pt-BR

必須: はい

LanguageModelName

文字起こしを処理する際に使用するカスタム言語モデルの名前を指定します。言語モデル名では大文字と小文字が区別されることに注意してください。

指定された言語モデルの言語は、文字起こしリクエストで指定した言語コードと一致する必要があります。言語が一致しない場合、カスタム言語モデルは適用されません。言語の不一致に関連するエラーや警告はありません。

詳細については、「カスタム言語モデル」を参照してください。

長さの制限: 最小長は 1 です。最大長は 200 です。

Pattern: ^[0-9a-zA-Z._-]+

MediaEncoding

入力オーディオのエンコーディングを指定します。サポートされる形式:

• FLAC

• Ogg コンテナ内の OPUS エンコードオーディオ

• PCM (符号付き 16 ビットリトルエンディアンオーディオフォーマットのみ、WAV は含まない)

詳しくは、「メディアフォーマット」を参照してください。

有効な値: pcm | ogg-opus | flac

必須: はい

MediaSampleRateHertz

入力音声のサンプルレート (Hz 単位)。電話オーディオなどの低品質オーディオは、通常約 8,000 Hz です。通常、高品質のオーディオの範囲は 16,000 ヘルツから 48,000 ヘルツです。指定するサンプルレートは、音声のサンプルレートと一致する必要があることに注意してください。

有効範囲: 最小値 は 8,000 です。最大値は 48,000 です。

必須: はい

PartialResultsStability

部分的な結果の安定化 (EnablePartialResultsStabilization) を有効にする場合に使用する安定性のレベルを指定します。

安定性が低いほど精度が高くなります。安定性が高いほど速く転写されますが、精度はわずかに低下します。

詳細については、部分結果安定化を参照してください。

有効な値: high | medium | low

PiiEntityTypes

書き起こしで編集したい個人を特定できる情報 (PII) の種類を指定します。タイプは必要な数だけ含めることも、選択することもできますALL。

Call AnalyticsPiiEntityTypes リクエストに含めるには、ContentIdentificationTypeまたはも含める必要がありますContentRedactionType。

値はカンマで区切る必要がありADDRESS、、BANK_ACCOUNT_NUMBER、BANK_ROUTING、CREDIT_DEBIT_CVV、CREDIT_DEBIT_EXPIRY、CREDIT_DEBIT_NUMBER、EMAIL、NAME、PHONEPINSSN、またはを含めることができますALL。

長さの制限: 最小長は 1 です。最大長は 300 です。

Pattern: ^[A-Z_, ]+

SessionId

Call Analytics トランスクリプションセッションの名前を指定します。リクエストにこのパラメータを含めない場合、Amazon Transcribe は ID を生成し、レスポンスの中でそれを返します。

長さの制限: 最大長は 36 です。

パターン: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

VocabularyFilterMethod

語彙フィルターをトランスクリプトにどのように適用するかを指定します。

単語をに置き換えるには***、を選択しますmask。

単語を削除するには、を選択しますremove。

単語を変更せずにフラグを付けるには、を選択しますtag。

有効な値: remove | mask | tag

VocabularyFilterName

文字起こしを処理する際に使用するカスタムボキャブラリーフィルターの名前を指定します。ボキャブラリーフィルター名では大文字と小文字が区別されます。

指定したカスタム語彙フィルターの言語が、メディアで指定されている言語と一致しない場合、語彙フィルターは文字起こしには適用されません。

詳細については、「不要な単語でのボキャブラリフィルタリングの使用」を参照してください。

長さの制限: 最小長は 1 です。最大長は 200 です。

Pattern: ^[0-9a-zA-Z._-]+

VocabularyName

文字起こしを処理する際に使用するカスタムボキャブラリーの名前を指定します。ボキャブラリー名では大文字と小文字が区別されます。

指定したカスタムボキャブラリーの言語がメディアで特定されている言語と一致しない場合、カスタムボキャブラリーはトランスクリプションには適用されません。

詳細については、[カスタム語彙] を参照してください。

長さの制限: 最小長は 1 です。最大長は 200 です。

Pattern: ^[0-9a-zA-Z._-]+

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

AudioStream

エンコードされたオーディオブロブのストリーミング。オーディオストリームは HTTP/2 WebSocket またはデータフレームとしてエンコードされます。

詳細については、ストリーミング音声の書き起こしを参照してください。

型: CallAnalyticsAudioStream オブジェクト

必須: はい

レスポンスの構文

HTTP/2 200
x-amzn-request-id: RequestId
x-amzn-transcribe-language-code: LanguageCode
x-amzn-transcribe-sample-rate: MediaSampleRateHertz
x-amzn-transcribe-media-encoding: MediaEncoding
x-amzn-transcribe-vocabulary-name: VocabularyName
x-amzn-transcribe-session-id: SessionId
x-amzn-transcribe-vocabulary-filter-name: VocabularyFilterName
x-amzn-transcribe-vocabulary-filter-method: VocabularyFilterMethod
x-amzn-transcribe-language-model-name: LanguageModelName
x-amzn-transcribe-enable-partial-results-stabilization: EnablePartialResultsStabilization
x-amzn-transcribe-partial-results-stability: PartialResultsStability
x-amzn-transcribe-content-identification-type: ContentIdentificationType
x-amzn-transcribe-content-redaction-type: ContentRedactionType
x-amzn-transcribe-pii-entity-types: PiiEntityTypes
Content-type: application/json

{
   "CallAnalyticsTranscriptResultStream": { 
      "BadRequestException": { 
      },
      "CategoryEvent": { 
         "MatchedCategories": [ "string" ],
         "MatchedDetails": { 
            "string" : { 
               "TimestampRanges": [ 
                  { 
                     "BeginOffsetMillis": number,
                     "EndOffsetMillis": number
                  }
               ]
            }
         }
      },
      "ConflictException": { 
      },
      "InternalFailureException": { 
      },
      "LimitExceededException": { 
      },
      "ServiceUnavailableException": { 
      },
      "UtteranceEvent": { 
         "BeginOffsetMillis": number,
         "EndOffsetMillis": number,
         "Entities": [ 
            { 
               "BeginOffsetMillis": number,
               "Category": "string",
               "Confidence": number,
               "Content": "string",
               "EndOffsetMillis": number,
               "Type": "string"
            }
         ],
         "IsPartial": boolean,
         "IssuesDetected": [ 
            { 
               "CharacterOffsets": { 
                  "Begin": number,
                  "End": number
               }
            }
         ],
         "Items": [ 
            { 
               "BeginOffsetMillis": number,
               "Confidence": number,
               "Content": "string",
               "EndOffsetMillis": number,
               "Stable": boolean,
               "Type": "string",
               "VocabularyFilterMatch": boolean
            }
         ],
         "ParticipantRole": "string",
         "Sentiment": "string",
         "Transcript": "string",
         "UtteranceId": "string"
      }
   }
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

レスポンスでは、以下の HTTP ヘッダーが返されます。

ContentIdentificationType

Call Analytics の文字起こしでコンテンツ識別が有効になっているかどうかを示します。

有効な値: PII

ContentRedactionType

Call Analytics の文字起こしでコンテンツの編集が有効になっているかどうかを示します。

有効な値: PII

EnablePartialResultsStabilization

Call Analytics の文字起こしの結果の部分安定化が有効になっているかどうかを示します。

LanguageCode

Call Analytics リクエストで指定した言語コードを提供します。

有効な値: en-US | en-GB | es-US | fr-CA | fr-FR | en-AU | it-IT | de-DE | pt-BR

LanguageModelName

Call Analytics リクエストで指定したカスタム言語モデルの名前を提供します。

長さの制限: 最小長は 1 です。最大長は 200 です。

Pattern: ^[0-9a-zA-Z._-]+

MediaEncoding

Call Analytics リクエストで指定したメディアエンコーディングを提供します。

有効な値: pcm | ogg-opus | flac

MediaSampleRateHertz

Call Analytics リクエストで指定したサンプルレートを提供します。

有効範囲: 最小値 は 8,000 です。48,000 の最大値。

PartialResultsStability

トランスクリプションに使用した安定化レベルが表示されます。

有効な値: high | medium | low

PiiEntityTypes

Call Analytics リクエストで指定した PII エンティティタイプを一覧表示します。

長さの制限: 最小長は 1 です。最大長は 300 です。

Pattern: ^[A-Z_, ]+

RequestId

リアルタイムのコール分析リクエストの識別子を提供します。

SessionId

Call Analytics トランスクリプションセッションの識別子を提供します。

長さの制限: 最大長は 36 です。

パターン: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

VocabularyFilterMethod

Call Analytics の文字起こしをする際に使用する語彙フィルタリング方法を提供します。

有効な値: remove | mask | tag

VocabularyFilterName

Call Analytics リクエストで指定したカスタムボキャブラリフィルターの名前を提供します。

長さの制限: 最小長は 1 です。最大長は 200 です。

Pattern: ^[0-9a-zA-Z._-]+

VocabularyName

Call Analytics リクエストで指定したカスタムボキャブラリーの名前を提供します。

長さの制限: 最小長は 1 です。最大長は 200 です。

Pattern: ^[0-9a-zA-Z._-]+

サービスから以下のデータが JSON 形式で返されます。

CallAnalyticsTranscriptResultStream

リアルタイムのコール分析セッションに関する詳細情報を提供します。

型: CallAnalyticsTranscriptResultStream オブジェクト

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

BadRequestException

StartStreamTranscription、StartMedicalStreamTranscription、StartCallAnalyticsStreamTranscriptionまたは操作の 1 つまたは複数の引数が無効でした。たとえば、MediaEncodingLanguageCodeまたはサポートされていない値を使用しました。指定されたパラメーターを確認して、リクエストを再度試みてください。

HTTP ステータスコード: 400

ConflictException

同じセッション ID で新しいストリーミングが開始されました。現在のストリーミングは終了しました。

HTTP ステータスコード: 409

InternalFailureException

音声処理中に問題が発生しました。Amazon Transcribe が処理を終了しました。

HTTP ステータスコード: 500

LimitExceededException

クライアントが Amazon Transcribe の制限の 1 つを超えています。これは通常、オーディオの長さの制限です。オーディオストリームをより小さなチャンクに分割して、リクエストを再試行してください。

HTTP ステータスコード: 429

ServiceUnavailableException

現在、サービスをご利用いただけません。後でリクエストを試してください。

HTTP ステータスコード: 503

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS コマンドラインインターフェイス

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS用の SDK JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3