Alibaba Cloud Model Studio:RESTful API

説明

音声認識タスクを送信します。

URL

リクエストメソッド

POST

リクエストヘッダー

Authorization: Bearer {api-key} // これを実際の API キーに置き換えてください
Content-Type: application/json
X-DashScope-Async: enable // このヘッダーは必須です。省略するとタスクが送信されません。

メッセージ本文

以下のメッセージ本文には、すべてのリクエストパラメーターが含まれています。必要に応じて、任意のフィールドを省略できます：

{
    "model":"fun-asr", // モデル名。必須。
    "input":{
        "file_urls":[
            "https://dashscope.oss-cn-beijing.aliyuncs.com/samples/audio/paraformer/hello_world_female2.wav",
            "https://dashscope.oss-cn-beijing.aliyuncs.com/samples/audio/paraformer/hello_world_male2.wav"
        ] // 認識対象のファイル。必須。
    },
    "parameters":{ 
        "channel_id":[
            0
        ], // 音声トラックのインデックス。任意。
        "special_word_filter": "xxx", // 機密ワード。任意。
        "diarization_enabled":false, // 自動話者分離。任意。
        "speaker_count": 2 // 話者の参考数。任意。
    }
}

パラメーター

型

デフォルト値

必須

説明

model

string

-

はい

音声および動画ファイルの文字起こしに使用するモデル名。詳しくは、「モデルの可用性」をご参照ください。

file_urls

array[string]

-

はい

音声および動画ファイルの URL（HTTP/HTTPS）。1 回のリクエストで最大 100 個の URL を指定できます。

vocabulary_id

string

-

いいえ

ホットワード ID。この ID に対応するホットワードが、認識タスクで有効になります。デフォルトでは無効です。「ホットワードのカスタマイズ」をご参照ください。

channel_id

array[integer]

[0]

いいえ

special_word_filter

string

-

いいえ

diarization_enabled

boolean

false

いいえ

speaker_id の例については、「認識結果の説明」をご参照ください。

speaker_count

integer

-

いいえ

話者の参考数（2～100 の整数）。このパラメーターは、diarization_enabled が true の場合にのみ有効です。デフォルトでは話者数は自動検出されます。このパラメーターはアルゴリズムを補助しますが、正確な数を保証するものではありません。

language_hints

array[string]

-

いいえ

パラメーター

型

説明

audio_format

string

ソースファイルの音声フォーマット。

channels

array[integer]

ソースファイル内の音声トラックのインデックス情報。シングルトラック音声では [0]、デュアルトラック音声では [0, 1] を返します。

original_sampling_rate

integer

ソースファイル内の音声のサンプルレート（Hz）。

original_duration_in_milliseconds

integer

ソースファイル内の音声の元の再生時間（ms）。

channel_id

integer

文字起こし結果の対象となる音声トラックのインデックス（0 から始まる）。

content_duration

integer

音声トラック内で音声として識別されたコンテンツの再生時間（ms）。

transcript

string

段落レベルの音声文字起こし結果。

sentences

array

文レベルの音声文字起こし結果。

words

array

単語レベルの音声文字起こし結果。

begin_time

integer

開始タイムスタンプ（ms）。

end_time

integer

終了タイムスタンプ（ms）。

text

string

音声文字起こし結果。

speaker_id

integer

現在の話者のインデックス（0 から始まる）。複数の話者を区別するために使用されます。

このフィールドは、話者分離機能が有効な場合にのみ認識結果に表示されます。

punctuation

string

単語の後に予測される句読点（ある場合）。

説明

音声認識タスクのステータスおよび結果を照会します。

URL

リクエストメソッド

POST

リクエストヘッダー

Authorization: Bearer {api-key} // これを実際の API キーに置き換えてください

メッセージ本文

なし。

パラメーター

型

デフォルト値

必須

説明

task_id

string

-

はい

クエリ対象のタスク ID。タスク送信 API から返される task_id です。

パラメーター

型

説明

task_id

string

照会対象のタスク ID。

task_status

string

照会対象のタスクのステータス。

subtask_status

string

サブタスクのステータス。

file_url

string

文字起こしタスクで処理されたファイルの URL。

transcription_url

string

認識結果へのリンク（有効期間：24 時間）。有効期限が切れた後は、以前の URL からのタスク照会および結果のダウンロードは失敗します。

結果は JSON 形式で保存されます。ファイルをダウンロードするか、HTTP リクエストで直接読み取ることができます。

JSON フィールドの説明については、「認識結果の説明」をご参照ください。

パラメーター

型

説明

audio_format

string

ソースファイル内の音声のフォーマット。

channels

array[integer]

ソースファイル内の音声トラックのインデックス情報。シングルトラック音声では [0]、デュアルトラック音声では [0, 1] を返します。

original_sampling_rate

integer

ソースファイル内の音声のサンプルレート（Hz）。

original_duration_in_milliseconds

integer

ソースファイル内の音声の元の再生時間（ms）。

channel_id

integer

文字起こし対象の音声トラックのインデックス（0 から始まる）。

content_duration

integer

音声トラック内で音声として識別されたコンテンツの再生時間（ms）。

transcript

string

段落レベルの音声文字起こし結果。

sentences

array

文レベルの音声文字起こし結果。

words

array

単語レベルの音声文字起こし結果。

begin_time

integer

開始タイムスタンプ（ms）。

end_time

integer

終了タイムスタンプ（ms）。

text

string

音声文字起こし結果。

speaker_id

integer

現在の話者のインデックス（0 から始まる）。複数の話者を区別するために使用されます。

このフィールドは、話者分離が有効な場合にのみ認識結果に表示されます。

punctuation

string

単語の後に予測される句読点（ある場合）。