Alibaba Cloud Model Studio:Paraformer 非リアルタイム音声認識 Python SDK

model

文字列

必須

Paraformer による音声ファイルおよび動画ファイルの文字起こしに使用するモデル名です。サポートされているモデルについては、リンク先をご参照ください。

file_urls

list[str]

必須

音声ファイルと動画ファイルの文字起こし用 URL のリストです。HTTP および HTTPS プロトコルに対応しています。1 回のリクエストで指定できる URL は 1 つのみです。

音声ファイルが Alibaba Cloud OSS に保存されている場合、SDK は oss:// プレフィックスを持つ一時的な URL をサポートしません。

vocabulary_id

文字列

任意

カスタム語彙の ID です。v2 シリーズのモデルに対応しており、言語設定が必要です。デフォルトでは無効になっています。詳細については、「カスタム語彙」をご参照ください。

channel_id

list[int]

[0]

任意

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

disfluency_removal_enabled

ブール値

False

任意

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

timestamp_alignment_enabled

ブール値

False

任意

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

special_word_filter

文字列

任意

音声認識中に処理する禁止用語を指定し、異なる禁止用語に対して異なる処理方法を設定できます。

このパラメーターが提供されない場合、システムは組み込みの禁止用語フィルタリングロジックを使用し、認識結果で 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

  • 型：Object。

  • 必須：いいえ。

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

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

  • 内部フィールド：

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

• filter_with_empty

  • 型：Object。

  • 必須：いいえ。

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

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

  • 内部フィールド：

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

• system_reserved_filter

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

language_hints

list[str]

["zh", "en"]

任意

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

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

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

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

diarization_enabled

ブール値

False

任意

自動話者分離。デフォルトでは無効です。

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

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

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

speaker_count

整数

任意

参考話者数です。値の範囲は 2～100 の整数です。

diarization_enabled が true の場合にのみ有効です。

デフォルトでは自動的に決定されます。このパラメーターはアルゴリズムのヒントとして使用されますが、正確な数を保証するものではありません。

status_code

HTTP リクエストのステータスコード。

code

• 最上位の code は無視できます。

• output.results 内の code フィールドはエラーコードです。message フィールドと併せて使用し、エラーコード を参照してトラブルシューティングを行ってください。

message

• 最上位の message は無視できます。

• output.results 配下の message はエラーメッセージです。code フィールドと併せて使用し、エラーコード を参照してトラブルシューティングを行ってください。

task_id

タスク ID。

task_status

タスクステータス。

ステータスには PENDING、RUNNING、SUCCEEDED、FAILED の 4 種類があります。

タスクに複数のサブタスクが含まれる場合、いずれかのサブタスクが成功すると、タスク全体のステータスは SUCCEEDED になります。各サブタスクの結果を判断するには、subtask_status フィールドを確認してください。

results

サブタスクの音声認識結果。

subtask_status

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

ステータスには PENDING、RUNNING、SUCCEEDED、FAILED の 4 種類があります。

file_url

認識する音声ファイルの URL。

transcription_url

音声認識結果に対応する URL。

音声認識結果は JSON ファイルとして保存されます。transcription_url の URL からファイルをダウンロードするか、HTTP リクエストでその内容を読み取ります。JSON ファイルの内容の詳細については、「認識結果の説明」をご参照ください。

code

エラーコード。message フィールドと併せて使用します。エラーコードをご参照ください。

message

エラーメッセージ。code フィールドと併せて使用します。エラーコードをご参照ください。

task_id

タスク ID。

task_status

タスクステータス。

ステータスには PENDING、RUNNING、SUCCEEDED、FAILED の 4 種類があります。

タスクに複数のサブタスクが含まれる場合、いずれかのサブタスクが成功すると、タスク全体のステータスは SUCCEEDED になります。各サブタスクの結果を判断するには、subtask_status フィールドを確認してください。

results

サブタスクの音声認識結果。

subtask_status

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

ステータスには PENDING、RUNNING、SUCCEEDED、FAILED の 4 種類があります。

file_url

認識する音声ファイルの URL。

transcription_url

音声認識結果に対応する URL。

音声認識結果は JSON ファイルとして保存されます。transcription_url からファイルをダウンロードするか、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

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

async_call

@classmethod
def async_call(cls,
               model: str,
               file_urls: List[str],
               phrase_id: str = None,
               api_key: str = None,
               workspace: str = None,
               **kwargs) -> TranscriptionResponse

音声認識タスクを非同期で送信します。

このメソッドは TranscriptionResponse を返します。

wait

@classmethod
def wait(cls,
         task: Union[str, TranscriptionResponse],
         api_key: str = None,
         workspace: str = None,
         **kwargs) -> TranscriptionResponse

非同期タスクが完了するまで (ステータスが SUCCEEDED または FAILED になるまで)、現在のスレッドをブロックします。

このメソッドは TranscriptionResponse を返します。

fetch

@classmethod
def fetch(cls,
          task: Union[str, TranscriptionResponse],
          api_key: str = None,
          workspace: str = None,
          **kwargs) -> TranscriptionResponse

非同期タスクの実行結果を照会します。

このメソッドは TranscriptionResponse を返します。