Alibaba Cloud Model Studio:Paraformer non-real-time speech recognition HTTP API

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

https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/audio/asr/transcription

POST

Authorization: Bearer {api-key} // {api-key} をご利用の API キーに置き換えてください。
Content-Type: application/json
X-DashScope-Async: enable // このリクエストヘッダーを省略しないでください。省略すると、タスクを送信できません。

次のコードは、すべてのリクエストパラメーターを含むメッセージ本文を示しています。必要に応じて、オプションのフィールドを省略できます。

{
    "model":"paraformer-v2", // モデル名。このパラメーターは必須です。
    "input":{
        "file_urls":[
            "{YOUR_AUDIO_URL}"
        ] // 認識対象のファイル。このパラメーターは必須です。
    },
    "parameters":{
        "channel_id":[
            0
        ], // オーディオトラックのインデックス。このパラメーターはオプションです。
        "disfluency_removal_enabled":false, // フィラーワードをフィルタリングするスイッチ。このパラメーターはオプションです。
        "timestamp_alignment_enabled": false, // タイムスタンプキャリブレーション機能を有効にするかどうかを指定します。このパラメーターはオプションです。
        "special_word_filter": "xxx", // 禁止用語。このパラメーターはオプションです。
        "language_hints":[ // このパラメーターは paraformer-v2 モデルにのみ適用されます。他のモデルではこのフィールドを使用しないでください。
            "zh",
            "en"
        ],
        "diarization_enabled":false, // 話者ダイアライゼーションの自動化を有効にするかどうかを指定します。このパラメーターはオプションです。
        "speaker_count": 2 // 話者の参照数。このパラメーターはオプションです。
    }
}

model

string

はい

音声・動画ファイルの文字起こしに使用される Paraformer モデルの名前。詳細については、「モデル」をご参照ください。

file_urls

array[string]

はい

音声・動画ファイルの文字起こし用の URL のリスト (HTTP/HTTPS)。1 回のリクエストでサポートされる URL は 1 つのみです。

音声ファイルが Object Storage Service (OSS) に保存されている場合、RESTful API は oss:// プレフィックスで始まる一時的な URL をサポートします。

vocabulary_id

string

いいえ

カスタム語彙 ID。言語構成を持つ v2+ モデルでサポートされています。この ID のホットワードは、現在の音声認識に適用されます。デフォルトでは無効になっています。使用方法については、「カスタムホットワード」をご参照ください。

channel_id

array[integer]

[0]

いいえ

マルチトラックオーディオファイルで認識するオーディオトラックのインデックスを指定します。インデックスは 0 から始まります。たとえば、[0] は最初のトラックを認識することを意味し、[0, 1] は最初のトラックと 2 番目のトラックの両方を同時に認識することを意味します。このパラメーターを省略した場合、デフォルトでは最初のトラックのみが処理されます。

disfluency_removal_enabled

boolean

false

いいえ

フィラーワードをフィルタリングします。デフォルトでは無効になっています。

timestamp_alignment_enabled

boolean

false

いいえ

タイムスタンプアライメント機能を有効にします。デフォルトでは無効になっています。

special_word_filter

string

いいえ

音声認識中に処理する禁止用語を指定し、異なる禁止用語に対して異なる処理方法を設定することをサポートします。

このパラメーターが提供されない場合、システムは組み込みの禁止用語フィルタリングロジックを使用し、認識結果で Alibaba Cloud Model Studio 禁止用語リスト に一致する単語は、同じ長さの * に置き換えられます。

このパラメーターが提供される場合、以下の禁止用語処理戦略を実装できます：

• * に置き換え：一致する禁止用語を同じ長さの * に置き換えます。
• 直接フィルタリング：認識結果から一致する禁止用語を完全に削除します。

このパラメーターの値は、次の構造を持つ JSON 文字列である必要があります：

{
  "filter_with_signed": {
    "word_list": ["test"]
  },
  "filter_with_empty": {
    "word_list": ["start", "happen"]
  },
  "system_reserved_filter": true
}

JSON フィールドの説明：

• filter_with_signed

  • タイプ：オブジェクト。

  • 必須：いいえ。

  • 説明：* に置き換える禁止用語のリストを構成します。認識結果で一致する単語は、同じ長さの * に置き換えられます。

  • 例：上記の JSON を使用すると、「Help me test this code」の音声認識結果は「Help me **** this code」になります。

  • 内部フィールド：

    • word_list：置き換える禁止用語をリストする文字列の配列。

• filter_with_empty

  • タイプ：オブジェクト。

  • 必須：いいえ。

  • 説明：認識結果から削除 (フィルタリング) する禁止用語のリストを構成します。一致する単語は完全に削除されます。

  • 例：上記の JSON を使用すると、「The game is about to start, right?」の音声認識結果は「The game is about to, right?」になります。

  • 内部フィールド：

    • word_list：完全に削除 (フィルタリング) する禁止用語をリストする文字列の配列。

• system_reserved_filter

  • タイプ：ブール値。
  • 必須：いいえ。
  • デフォルト：true。
  • 説明：システムの組み込み禁止用語ルールを有効にするかどうか。 true に設定すると、システムの組み込み禁止用語フィルタリングロジックも有効になり、認識結果で Alibaba Cloud Model Studio 禁止用語リスト に一致する単語は、同じ長さの * に置き換えられます。

language_hints

array[string]

["zh", "en"]

いいえ

認識する音声の言語コードを指定します。

このパラメーターは paraformer-v2 モデルにのみ適用されます。

サポートされている言語コード：

• zh：中国語
• en：英語
• ja：日本語
• yue：広東語
• ko：韓国語
• de：ドイツ語
• fr：フランス語
• ru：ロシア語

diarization_enabled

boolean

false

いいえ

話者ダイアライゼーションの自動化。デフォルトでは無効になっています。

モノラル音声にのみ適用されます。マルチチャンネル音声は話者ダイアライゼーションをサポートしていません。

この機能を有効にすると、認識結果に異なる話者を区別するための speaker_id フィールドが含まれます。

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

speaker_count

integer

いいえ

話者数の参照値 (2 から 100 までの整数)。

diarization_enabled が true の場合に有効になります。

話者数はデフォルトで自動的に決定されます。このパラメーターを構成すると、アルゴリズムが指定された数を目標とするのに役立ちますが、正確な出力を保証するものではありません。

audio_format

文字列

ソースファイルのオーディオフォーマットです。

channels

配列[整数]

ソースファイルのオーディオトラックのインデックス情報です。モノラルオーディオの場合は [0]、デュアルトラックオーディオの場合は [0, 1] のように返されます。

original_sampling_rate

整数

ソースファイル内のオーディオのサンプリングレート (Hz) です。

original_duration

整数

ソースファイルの元のオーディオの長さ (ms) です。

channel_id

整数

文字起こし結果のオーディオトラックのインデックスで、0 から始まります。

content_duration

整数

オーディオトラック内で音声として識別されたコンテンツの長さ (ms) です。

transcript

文字列

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

sentences

配列

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

words

配列

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

begin_time

整数

開始タイムスタンプ (ms) です。

end_time

整数

終了タイムスタンプ (ms) です。

text

文字列

音声文字起こし結果です。

speaker_id

整数

現在の話者のインデックスで、0 から始まります。異なる話者を区別するために使用されます。

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

punctuation

文字列

単語の後に予測された句読点です (存在する場合)。

音声認識タスクのステータスと結果をクエリします。

https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/tasks/{task_id}

GET

Authorization: Bearer {api-key} // {api-key} をご利用の API キーに置き換えてください。

なし。

task_id

string

-

はい

クエリに必要なタスク ID。タスク送信インターフェイスによって返されます。

task_id

string

クエリされたタスクの ID。

task_status

string

クエリされたタスクのステータス。

subtask_status

string

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

file_url

string

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

transcription_url

string

認識結果を取得するためのリンク (24 時間有効)。有効期限が切れると、タスクのクエリと結果のダウンロードは失敗します。

認識結果は JSON として保存されます。このリンクからダウンロードするか、HTTP リクエストを介して直接読み取ります。

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

audio_format

string

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

channels

array[integer]

ソースファイルのオーディオトラックのインデックス情報。モノラル音声の場合は [0]、デュアルトラック音声の場合は [0, 1] などを返します。

original_sampling_rate

integer

ソースファイル内の音声のサンプリングレート (Hz)。

original_duration

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

単語の後に予測された句読点 (もしあれば)。