Package google.cloud.speech.v2

インデックス

音声

音声文字変換とリソース管理を有効にします。

BatchRecognize

rpc BatchRecognize(BatchRecognizeRequest) returns (Operation)

一括非同期音声認識を実行します。N 個の音声ファイルを含むリクエストを送信し、音声文字変換が完了したかどうかをポーリングできる長時間実行オペレーションを受信します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

recognizer リソースに対する次の IAM 権限が必要です。

  • speech.recognizers.recognize

詳細については、IAM のドキュメントをご覧ください。

CreateCustomClass

rpc CreateCustomClass(CreateCustomClassRequest) returns (Operation)

CustomClass を作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • speech.customClasses.create

詳細については、IAM のドキュメントをご覧ください。

CreatePhraseSet

rpc CreatePhraseSet(CreatePhraseSetRequest) returns (Operation)

PhraseSet を作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • speech.phraseSets.create

詳細については、IAM のドキュメントをご覧ください。

CreateRecognizer

rpc CreateRecognizer(CreateRecognizerRequest) returns (Operation)

Recognizer を作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • speech.recognizers.create

詳細については、IAM のドキュメントをご覧ください。

DeleteCustomClass

rpc DeleteCustomClass(DeleteCustomClassRequest) returns (Operation)

CustomClass を削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • speech.customClasses.delete

詳細については、IAM のドキュメントをご覧ください。

DeletePhraseSet

rpc DeletePhraseSet(DeletePhraseSetRequest) returns (Operation)

PhraseSet を削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • speech.phraseSets.delete

詳細については、IAM のドキュメントをご覧ください。

DeleteRecognizer

rpc DeleteRecognizer(DeleteRecognizerRequest) returns (Operation)

Recognizer を削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • speech.recognizers.delete

詳細については、IAM のドキュメントをご覧ください。

GetConfig

rpc GetConfig(GetConfigRequest) returns (Config)

リクエストされた Config を返します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • speech.config.get

詳細については、IAM のドキュメントをご覧ください。

GetCustomClass

rpc GetCustomClass(GetCustomClassRequest) returns (CustomClass)

リクエストされた CustomClass を返します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • speech.customClasses.get

詳細については、IAM のドキュメントをご覧ください。

GetPhraseSet

rpc GetPhraseSet(GetPhraseSetRequest) returns (PhraseSet)

リクエストされた PhraseSet を返します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • speech.phraseSets.get

詳細については、IAM のドキュメントをご覧ください。

GetRecognizer

rpc GetRecognizer(GetRecognizerRequest) returns (Recognizer)

リクエストされた Recognizer を返します。リクエストされた Recognizer が存在しない場合は、NOT_FOUND で失敗します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • speech.recognizers.get

詳細については、IAM のドキュメントをご覧ください。

ListCustomClasses

rpc ListCustomClasses(ListCustomClassesRequest) returns (ListCustomClassesResponse)

CustomClass を一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • speech.customClasses.list

詳細については、IAM のドキュメントをご覧ください。

ListPhraseSets

rpc ListPhraseSets(ListPhraseSetsRequest) returns (ListPhraseSetsResponse)

PhraseSet を一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • speech.phraseSets.list

詳細については、IAM のドキュメントをご覧ください。

ListRecognizers

rpc ListRecognizers(ListRecognizersRequest) returns (ListRecognizersResponse)

認識ツールを一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • speech.recognizers.list

詳細については、IAM のドキュメントをご覧ください。

認識

rpc Recognize(RecognizeRequest) returns (RecognizeResponse)

同期音声認識を実行します。すべての音声が送信されて処理された後に結果を受け取ります。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

recognizer リソースに対する次の IAM 権限が必要です。

  • speech.recognizers.recognize

詳細については、IAM のドキュメントをご覧ください。

StreamingRecognize

rpc StreamingRecognize(StreamingRecognizeRequest) returns (StreamingRecognizeResponse)

音声認識を双方向ストリーミングで実行します。音声を送信しながら結果を受け取ります。このメソッドは、REST ではなく、gRPC API を介してのみ使用できます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

recognizer リソースに対する次の IAM 権限が必要です。

  • speech.recognizers.recognize

詳細については、IAM のドキュメントをご覧ください。

UndeleteCustomClass

rpc UndeleteCustomClass(UndeleteCustomClassRequest) returns (Operation)

CustomClass の削除を取り消します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • speech.customClasses.undelete

詳細については、IAM のドキュメントをご覧ください。

UndeletePhraseSet

rpc UndeletePhraseSet(UndeletePhraseSetRequest) returns (Operation)

PhraseSet の削除を取り消します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • speech.phraseSets.undelete

詳細については、IAM のドキュメントをご覧ください。

UndeleteRecognizer

rpc UndeleteRecognizer(UndeleteRecognizerRequest) returns (Operation)

Recognizer の削除を取り消します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • speech.recognizers.undelete

詳細については、IAM のドキュメントをご覧ください。

UpdateConfig

rpc UpdateConfig(UpdateConfigRequest) returns (Config)

Config を更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • speech.config.update

詳細については、IAM のドキュメントをご覧ください。

UpdateCustomClass

rpc UpdateCustomClass(UpdateCustomClassRequest) returns (Operation)

CustomClass を更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • speech.customClasses.update

詳細については、IAM のドキュメントをご覧ください。

UpdatePhraseSet

rpc UpdatePhraseSet(UpdatePhraseSetRequest) returns (Operation)

PhraseSet を更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • speech.phraseSets.update

詳細については、IAM のドキュメントをご覧ください。

UpdateRecognizer

rpc UpdateRecognizer(UpdateRecognizerRequest) returns (Operation)

Recognizer を更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • speech.recognizers.update

詳細については、IAM のドキュメントをご覧ください。

AccessMetadata

特定のリージョンのアクセス メタデータ。これは、特定のプロジェクトの組織のポリシーで特定のリージョンが禁止されている場合に適用できます。

フィールド
constraint_type

ConstraintType

適用されるさまざまなタイプの制約について説明します。

ConstraintType

リージョンに適用できるさまざまな種類の制約について説明します。

列挙型
CONSTRAINT_TYPE_UNSPECIFIED 未指定の制約が適用されます。
RESOURCE_LOCATIONS_ORG_POLICY_CREATE_CONSTRAINT プロジェクトの組織ポリシーで、指定したリージョンが禁止されます。

AutoDetectDecodingConfig

この型にはフィールドがありません。

自動的に検出されたデコード パラメータ。次のエンコードでサポートされています。

  • WAV_LINEAR16: WAV コンテナ内の 16 ビット符号付きリトル エンディアン PCM サンプル。

  • WAV_MULAW: WAV コンテナ内の 8 ビットの圧縮された mulaw サンプル。

  • WAV_ALAW: WAV コンテナ内の 8 ビットの圧縮された alaw サンプル。

  • RFC4867_5_AMR: rfc4867.5 ヘッダーを含む AMR フレーム。

  • RFC4867_5_AMRWB: rfc4867.5 ヘッダーを含む AMR-WB フレーム。

  • FLAC: 「ネイティブ FLAC」コンテナ形式の FLAC フレーム。

  • MP3: MPEG 音声フレーム。ID3 メタデータは省略可能(無視されます)。

  • OGG_OPUS: Ogg コンテナ内の Opus 音声フレーム。

  • WEBM_OPUS: WebM コンテナ内の Opus 音声フレーム。

  • MP4_AAC: MP4 コンテナ内の AAC 音声フレーム。

  • M4A_AAC: M4A コンテナ内の AAC 音声フレーム。

  • MOV_AAC: MOV コンテナ内の AAC 音声フレーム。

BatchRecognizeFileMetadata

BatchRecognize のバッチ内の単一ファイルに関するメタデータ。

フィールド
config

RecognitionConfig

自動音声認識に使用する特徴と音声メタデータ。このフィールドと config_mask フィールドを組み合わせて使用すると、Recognizer リソースの default_recognition_config の一部と、リクエスト レベルの config をオーバーライドできます。

config_mask

FieldMask

この認識リクエスト中に認識ツールの default_recognition_config の値をオーバーライドする config のフィールドのリスト。マスクが指定されていない場合、config のデフォルト値以外のフィールドはすべて、この認識リクエストの認識ツールの値よりも優先されます。マスクが指定されている場合、マスクにリストされているフィールドについてのみ、この認識リクエストの認識ツールの構成をオーバーライドします。ワイルドカード(*)を指定すると、config は、この認識リクエストの認識ツールの構成を完全にオーバーライドして置き換えます。

共用体フィールド audio_source。Google Cloud Storage URI の音声ソース。audio_source は次のいずれかになります。
uri

string

音声ファイルの Cloud Storage URI。

BatchRecognizeFileResult

単一ファイルの最終結果。

フィールド
error

Status

エラーが発生した場合のエラー。

metadata

RecognitionResponseMetadata

uri
(deprecated)

string

非推奨。cloud_storage_result.native_format_uri を代わりに使用してください。

transcript
(deprecated)

BatchRecognizeResults

非推奨。inline_result.transcript を代わりに使用してください。

共用体フィールド result

result は次のいずれかになります。

cloud_storage_result

CloudStorageResult

認識結果が Cloud Storage に書き込まれます。これは、[RecognitionOutputConfig][google.cloud.speech.v2.RecognitionOutputConfig] で GcsOutputConfig が設定されている場合にのみ入力されます。

inline_result

InlineResult

認識結果。これは、[RecognitionOutputConfig][google.cloud.speech.v2.RecognitionOutputConfig] で InlineOutputConfig が設定されている場合にのみ入力されます。

BatchRecognizeMetadata

BatchRecognize のオペレーション メタデータ。

フィールド
transcription_metadata

map<string, BatchRecognizeTranscriptionMetadata>

指定されたファイル名と、そのファイルの文字起こしメタデータを対応付けるマップ。

BatchRecognizeRequest

BatchRecognize メソッドに対するリクエスト メッセージ。

フィールド
recognizer

string

必須。認識中に使用する認識機能の名前。projects/{project}/locations/{location}/recognizers/{recognizer} という形式で指定してください。{recognizer} セグメントを _ に設定して、空の暗黙的な Recognizer を使用できます。

config

RecognitionConfig

自動音声認識に使用する特徴と音声メタデータ。このフィールドと config_mask フィールドを組み合わせて、Recognizer リソースの default_recognition_config の一部をオーバーライドできます。

config_mask

FieldMask

この認識リクエスト中に認識ツールの default_recognition_config の値をオーバーライドする config のフィールドのリスト。マスクが指定されていない場合、config で指定されたすべてのフィールドは、この認識リクエストの認識ツールの値よりも優先されます。マスクが指定されている場合、マスクにリストされているフィールドについてのみ、この認識リクエストの認識ツールの構成をオーバーライドします。ワイルドカード(*)を指定すると、config は、この認識リクエストの認識ツールの構成を完全にオーバーライドして置き換えます。

files[]

BatchRecognizeFileMetadata

ASR のファイル メタデータを含む音声ファイル。指定できるファイル数の上限は 15 です。

recognition_output_config

RecognitionOutputConfig

各ファイルの文字起こしを出力する場所の構成オプション。

processing_strategy

ProcessingStrategy

このリクエストに使用する処理戦略。

ProcessingStrategy

バッチ リクエストの処理戦略。

列挙型
PROCESSING_STRATEGY_UNSPECIFIED 処理戦略のデフォルト値。リクエストは受信するとすぐに処理されます。
DYNAMIC_BATCHING 選択すると、使用率が低い期間にリクエストを処理して、料金割引が適用されます。リクエストは 24 時間以内に完了します。

BatchRecognizeResponse

longrunning Operation にパッケージ化された BatchRecognize のレスポンス メッセージ。

フィールド
results

map<string, BatchRecognizeFileResult>

ファイル名からそのファイルの最終結果へのマップ。

total_billed_duration

Duration

対応するリクエストの課金対象音声秒数(利用可能な場合)。

BatchRecognizeResults

BatchRecognize トランスクリプトの Cloud Storage の出力タイプ。この proto はこの API のどこでも返されませんが、Cloud Storage の文字起こしはこの proto がシリアル化されたものであり、そのように解析する必要があります。

フィールド
results[]

SpeechRecognitionResult

音声の連続する部分に対応する音声文字変換結果の連続するリスト。

metadata

RecognitionResponseMetadata

認識に関するメタデータ。

BatchRecognizeTranscriptionMetadata

単一のファイルの文字起こしに関するメタデータ(進行状況の割合など)。

フィールド
progress_percent

int32

ファイルがどの程度文字起こしされたか。

error

Status

エラーが発生した場合のエラー。

uri

string

認識結果が書き込まれる Cloud Storage URI。

CloudStorageResult

最終結果が Cloud Storage に書き込まれます。

フィールド
uri

string

認識結果が書き込まれた Cloud Storage URI。

vtt_format_uri

string

認識結果が VTT 形式のキャプションとして書き込まれた Cloud Storage URI。これは、VTT 出力がリクエストされた場合にのみ入力されます。

srt_format_uri

string

認識結果が SRT 形式のキャプションとして書き込まれた Cloud Storage URI。これは、SRT 出力がリクエストされた場合にのみ入力されます。

構成

Speech-to-Text API の構成を表すメッセージ。これには、受信データの暗号化に使用されるオプションの KMS 鍵が含まれます。

フィールド
name

string

出力専用。ID。構成リソースの名前。ロケーションごとにプロジェクトごとに 1 つの構成リソースがあります。projects/{project}/locations/{location}/config という形式で指定してください。

kms_key_name

string

省略可。省略可能な KMS 鍵名。指定すると、保存時の Speech-to-Text リソースの暗号化に使用されます。この鍵を更新しても、この鍵を使用している既存のリソースは暗号化されません。この鍵を使用して暗号化されるのは、新しいリソースのみです。projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} という形式で指定してください。

update_time

Timestamp

出力専用。このリソースが最後に変更された時刻。

CreateCustomClassRequest

CreateCustomClass メソッドに対するリクエスト メッセージ。

フィールド
custom_class

CustomClass

必須。作成する CustomClass。

validate_only

bool

設定されている場合、リクエストを検証し、CustomClass をプレビューしますが、実際には作成しません。

custom_class_id

string

CustomClass に使用する ID。CustomClass のリソース名の最終的なコンポーネントになります。

この値は 4~63 文字で、有効な文字は /[a-z][0-9]-/ です。

parent

string

必須。この CustomClass が作成されるプロジェクトとロケーション。projects/{project}/locations/{location} という形式で指定してください。

CreatePhraseSetRequest

CreatePhraseSet メソッドに対するリクエスト メッセージ。

フィールド
phrase_set

PhraseSet

必須。作成する PhraseSet。

validate_only

bool

設定されている場合、リクエストを検証し、PhraseSet をプレビューしますが、実際には作成しません。

phrase_set_id

string

PhraseSet に使用する ID。PhraseSet のリソース名の最終的なコンポーネントになります。

この値は 4~63 文字で、有効な文字は /[a-z][0-9]-/ です。

parent

string

必須。この PhraseSet が作成されるプロジェクトとロケーション。projects/{project}/locations/{location} という形式で指定してください。

CreateRecognizerRequest

CreateRecognizer メソッドに対するリクエスト メッセージ。

フィールド
recognizer

Recognizer

必須。作成する Recognizer。

validate_only

bool

設定されている場合、リクエストを検証し、Recognizer をプレビューしますが、実際には作成しません。

recognizer_id

string

Recognizer に使用する ID。Recognizer のリソース名の最終的なコンポーネントになります。

この値は 4~63 文字で、有効な文字は /[a-z][0-9]-/ です。

parent

string

必須。この Recognizer が作成されるプロジェクトとロケーション。projects/{project}/locations/{location} という形式で指定してください。

CustomClass

音声認識のバイアス用の CustomClass。音声に現れる可能性のある一般的なコンセプトやテーマを表す単語やフレーズのセットを定義するために使用されます。たとえば、客船の名前のリストなどです。

フィールド
name

string

出力専用。ID。CustomClass のリソース名。形式: projects/{project}/locations/{location}/customClasses/{custom_class}

uid

string

出力専用。システムによって割り当てられた CustomClass の固有識別子。

display_name

string

省略可。ユーザーが設定可能な、人が読める形式の CustomClass の名前。63 文字以下にしてください。

items[]

ClassItem

クラスアイテムのコレクション。

state

State

出力専用。CustomClass のライフサイクル ステータス。

create_time

Timestamp

出力専用。作成時間。

update_time

Timestamp

出力専用。このリソースが最後に変更された時刻。

delete_time

Timestamp

出力専用。このリソースの削除がリクエストされた時刻。

expire_time

Timestamp

出力専用。このリソースがパージされる時刻。

annotations

map<string, string>

省略可。任意の少量のデータを保存できます。キーと値はそれぞれ 63 文字以下にする必要があります。アノテーションは最大 100 個まで。

etag

string

出力専用。このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されます。これは、更新リクエスト、削除取り消しリクエスト、削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

reconciling

bool

出力専用。この CustomClass が更新中かどうか。

kms_key_name

string

出力専用。CustomClass が暗号化される KMS 鍵の名前projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} という形式で指定してください。

kms_key_version_name

string

出力専用。CustomClass が暗号化される KMS 鍵バージョン名projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} という形式で指定してください。

ClassItem

クラスの項目。

フィールド
value

string

クラス項目の値。

状態

CustomClass のライフサイクルを定義する状態のセット。

列挙型
STATE_UNSPECIFIED 未指定の状態。これは、未設定の値を区別するためだけに使用され、役に立ちます。
ACTIVE 通常およびアクティブな状態。
DELETED この CustomClass は削除されました。

DeleteCustomClassRequest

DeleteCustomClass メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。削除する CustomClass の名前。形式: projects/{project}/locations/{location}/customClasses/{custom_class}

validate_only

bool

設定されている場合、リクエストを検証し、削除された CustomClass をプレビューしますが、実際には削除しません。

allow_missing

bool

true に設定されていて CustomClass が見つからない場合、リクエストは成功し、no-op になります(この場合、オペレーションは記録されません)。

etag

string

このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されます。これは、更新リクエスト、削除取り消しリクエスト、削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

DeletePhraseSetRequest

DeletePhraseSet メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。削除する PhraseSet の名前。形式: projects/{project}/locations/{location}/phraseSets/{phrase_set}

validate_only

bool

設定されている場合、リクエストを検証し、削除された PhraseSet をプレビューしますが、実際には削除しません。

allow_missing

bool

true に設定されていて PhraseSet が見つからない場合、リクエストは成功し、no-op になります(この場合、オペレーションは記録されません)。

etag

string

このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されます。これは、更新リクエスト、削除取り消しリクエスト、削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

DeleteRecognizerRequest

DeleteRecognizer メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。削除する Recognizer の名前。形式: projects/{project}/locations/{location}/recognizers/{recognizer}

validate_only

bool

設定されている場合、リクエストを検証し、削除された Recognizer をプレビューしますが、実際には削除しません。

allow_missing

bool

true に設定されていて Recognizer が見つからない場合、リクエストは成功し、no-op になります(この場合、オペレーションは記録されません)。

etag

string

このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されます。これは、更新リクエスト、削除取り消しリクエスト、削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

DenoiserConfig

ノイズ除去機能の構成。一部のモデルではサポートされていない場合や、効果がない場合があります。

フィールド
denoise_audio

bool

音声文字変換モデルに送信する前に音声のノイズを除去します。

snr_threshold

float

ノイズ除去の信号対雑音比(SNR)のしきい値。ここで、SNR は音声信号のラウドネスを意味します。SNR がこのしきい値を下回る音声(音声が小さすぎる)は、音声文字変換モデルに送信されません。

snr_threshold=0 の場合、フィルタリングは適用されません。

ExplicitDecodingConfig

明示的に指定されたデコード パラメータ。

フィールド
encoding

AudioEncoding

必須。認識のために送信される音声データのエンコード。

sample_rate_hertz

int32

省略可。認識のために送信される音声データのサンプルレート(ヘルツ単位)。有効な値は 8,000 ~ 48,000 ですが、16,000 が最適です。最良の結果を得るには、音源のサンプリング レートを 16,000 Hz に設定します。不可能な場合は、(再サンプリングせずに)音源のネイティブ サンプリング レートを使用します。下位互換性の理由から、このフィールドは OPTIONAL とマークされています。これは事実上必須です(これまでもそうでした)。

audio_channel_count

int32

省略可。認識のために送信された音声データに含まれるチャンネル数。下位互換性の理由から、このフィールドは OPTIONAL とマークされています。これは事実上必須です(これまでもそうでした)。

最大値は 8 です。

AudioEncoding

サポートされている音声データ エンコード。

列挙型
AUDIO_ENCODING_UNSPECIFIED デフォルト値。この値は使用されません。
LINEAR16 ヘッダーなしの 16 ビット符号付きリトル エンディアン PCM サンプル。
MULAW ヘッダーなしの 8 ビット圧縮 mulaw サンプル。
ALAW ヘッダーなしの 8 ビット圧縮 alaw サンプル。
AMR rfc4867.5 ヘッダーを含む AMR フレーム。
AMR_WB rfc4867.5 ヘッダーを含む AMR-WB フレーム。
FLAC 「ネイティブ FLAC」コンテナ形式の FLAC フレーム。
MP3 オプションの(無視される)ID3 メタデータを含む MPEG 音声フレーム。
OGG_OPUS Ogg コンテナ内の Opus 音声フレーム。
WEBM_OPUS WebM コンテナ内の Opus 音声フレーム。
MP4_AAC MP4 コンテナ内の AAC 音声フレーム。
M4A_AAC M4A コンテナ内の AAC 音声フレーム。
MOV_AAC MOV コンテナ内の AAC 音声フレーム。

GcsOutputConfig

Cloud Storage の出力構成。

フィールド
uri

string

認識結果が書き込まれる Cloud Storage URI プレフィックス。

GetConfigRequest

GetConfig メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。取得する構成の名前。ロケーションごとにプロジェクトごとに 1 つの構成リソースがあります。projects/{project}/locations/{location}/config という形式で指定してください。

GetCustomClassRequest

GetCustomClass メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。取得する CustomClass の名前。projects/{project}/locations/{location}/customClasses/{custom_class} という形式で指定してください。

GetPhraseSetRequest

GetPhraseSet メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。取得する PhraseSet の名前。projects/{project}/locations/{location}/phraseSets/{phrase_set} という形式で指定してください。

GetRecognizerRequest

GetRecognizer メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。取得する Recognizer の名前。projects/{project}/locations/{location}/recognizers/{recognizer} という形式で指定してください。

InlineOutputConfig

この型にはフィールドがありません。

インライン レスポンスの出力構成。

InlineResult

最終結果は、認識レスポンスでインラインで返されます。

フィールド
transcript

BatchRecognizeResults

音声ファイルの文字起こし。

vtt_captions

string

音声ファイルの文字起こし(VTT 形式の字幕)。これは、VTT 出力がリクエストされた場合にのみ入力されます。

srt_captions

string

音声ファイルの文字起こし(SRT 形式の字幕)。これは、SRT 出力がリクエストされた場合にのみ入力されます。

LanguageMetadata

特定の地域で利用可能なロケールに関するメタデータ。現在、これは各ロケールで使用可能なモデルのみです。

フィールド
models

map<string, ModelMetadata>

ロケール(言語コード) -> モデルのマッピング

ListCustomClassesRequest

ListCustomClasses メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。一覧表示する CustomClass リソースのプロジェクトとロケーション。projects/{project}/locations/{location} という形式で指定してください。

page_size

int32

リクエストあたりの結果の数。有効な page_size の範囲は 0 ~ 100 です。page_size が 0 または未指定の場合、ページサイズは 5 になります。ページサイズが 100 を超える場合は、100 に強制変換されます。呼び出しから返される結果は、リクエストしたページサイズよりも少ない場合があります。

page_token

string

前回の ListCustomClasses 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListCustomClasses に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

show_deleted

bool

削除されたリソースを表示するかどうか。

ListCustomClassesResponse

ListCustomClasses メソッドに対するレスポンス メッセージ。

フィールド
custom_classes[]

CustomClass

リクエストされた CustomClass のリスト。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。このトークンは 72 時間後に期限切れになります。

ListPhraseSetsRequest

ListPhraseSets メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。一覧表示する PhraseSet リソースのプロジェクトとロケーション。projects/{project}/locations/{location} という形式で指定してください。

page_size

int32

返される PhraseSet の最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 5 個の PhraseSet が返されます。最大値は 100 です。100 を超える値は 100 に強制変換されます。

page_token

string

前回の ListPhraseSets 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListPhraseSets に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

show_deleted

bool

削除されたリソースを表示するかどうか。

ListPhraseSetsResponse

ListPhraseSets メソッドに対するレスポンス メッセージ。

フィールド
phrase_sets[]

PhraseSet

リクエストされた PhraseSet のリスト。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。このトークンは 72 時間後に期限切れになります。

ListRecognizersRequest

ListRecognizers メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。一覧表示する Recognizer のプロジェクトとロケーション。projects/{project}/locations/{location} という形式で指定してください。

page_size

int32

返す Recognizer の最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 5 個の Recognizer が返されます。最大値は 100 です。100 を超える値は 100 に強制変換されます。

page_token

string

前回の ListRecognizers 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListRecognizers に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

show_deleted

bool

削除されたリソースを表示するかどうか。

ListRecognizersResponse

ListRecognizers メソッドに対するレスポンス メッセージ。

フィールド
recognizers[]

Recognizer

リクエストされた Recognizer のリスト。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。このトークンは 72 時間後に期限切れになります。

LocationsMetadata

STT V2 の Locations API のメイン メタデータ。現在、これはロケール、モデル、機能に関するメタデータのみです。

フィールド
languages

LanguageMetadata

使用可能なロケール、モデル、機能に関する情報。ロケール -> モデル -> 機能の階層構造で表されます。

access_metadata

AccessMetadata

リージョンと指定されたプロジェクトのアクセス メタデータに関する情報。

ModelFeature

モデルの単一の特徴を表します。特徴が recognizer の場合、特徴の release_state はモデルの release_state を表します。

フィールド
feature

string

機能の名前(注: 機能は recognizer にできます)

release_state

string

機能のリリース状態

ModelFeatures

モデルに属する特徴のコレクションを表します

フィールド
model_feature[]

ModelFeature

モデルのすべての特徴を含む繰り返しフィールド

ModelMetadata

特定の言語 / 地域における特定のリージョンのモデルに関するメタデータ。現時点では、これはモデルの特徴量のみです。

フィールド
model_features

map<string, ModelFeatures>

モデル名 -> そのモデルの特徴のマップ

NativeOutputFileFormatConfig

この型にはフィールドがありません。

シリアル化された BatchRecognizeResults proto の出力構成。

OperationMetadata

長時間実行オペレーションのメタデータを表します。

フィールド
create_time

Timestamp

オペレーションが作成された時刻。

update_time

Timestamp

オペレーションが最後に更新された時刻。

resource

string

オペレーションのターゲットのリソースパス。

method

string

オペレーションをトリガーしたメソッド。

kms_key_name

string

オペレーションのコンテンツが暗号化される KMS 鍵の名前projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} という形式で指定してください。

kms_key_version_name

string

オペレーションのコンテンツが暗号化される KMS 鍵バージョン名projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} という形式で指定してください。

progress_percent

int32

オペレーションの進行状況(パーセント)。値の範囲は 0 ~ 100 です。値が 100 の場合、オペレーションは完了しています。

共用体フィールド request。オペレーションを生成したリクエスト。request は次のいずれかになります。
batch_recognize_request

BatchRecognizeRequest

オペレーションを生成した BatchRecognizeRequest。

create_recognizer_request

CreateRecognizerRequest

オペレーションを生成した CreateRecognizerRequest。

update_recognizer_request

UpdateRecognizerRequest

オペレーションを生成した UpdateRecognizerRequest。

delete_recognizer_request

DeleteRecognizerRequest

オペレーションを生成した DeleteRecognizerRequest。

undelete_recognizer_request

UndeleteRecognizerRequest

オペレーションを生成した UndeleteRecognizerRequest。

create_custom_class_request

CreateCustomClassRequest

オペレーションを生成した CreateCustomClassRequest。

update_custom_class_request

UpdateCustomClassRequest

オペレーションを生成した UpdateCustomClassRequest。

delete_custom_class_request

DeleteCustomClassRequest

オペレーションを生成した DeleteCustomClassRequest。

undelete_custom_class_request

UndeleteCustomClassRequest

オペレーションを生成した UndeleteCustomClassRequest。

create_phrase_set_request

CreatePhraseSetRequest

オペレーションを生成した CreatePhraseSetRequest。

update_phrase_set_request

UpdatePhraseSetRequest

オペレーションを生成した UpdatePhraseSetRequest。

delete_phrase_set_request

DeletePhraseSetRequest

オペレーションを生成した DeletePhraseSetRequest。

undelete_phrase_set_request

UndeletePhraseSetRequest

オペレーションを生成した UndeletePhraseSetRequest。

update_config_request
(deprecated)

UpdateConfigRequest

オペレーションを生成した UpdateConfigRequest。

共用体フィールド metadata。RPC ごとの特定のメタデータ。metadata は次のいずれかになります。
batch_recognize_metadata

BatchRecognizeMetadata

BatchRecognize メソッドに固有のメタデータ。

OutputFormatConfig

output に保存される結果の形式の構成。

フィールド
native

NativeOutputFileFormatConfig

ネイティブ出力形式の構成。このフィールドが設定されている場合、または他の出力形式フィールドが設定されていない場合、文字起こしはネイティブ形式でシンクに書き込まれます。

vtt

VttOutputFileFormatConfig

VTT 出力形式の構成。このフィールドが設定されている場合、文字起こしは VTT 形式でシンクに書き込まれます。

srt

SrtOutputFileFormatConfig

SRT 出力形式の構成。このフィールドが設定されている場合、文字起こしは SRT 形式でシンクに書き込まれます。

PhraseSet

音声認識のバイアス調整用の PhraseSet。PhraseSet は、結果の中の特定の語句を優先するように、音声認識機能に「ヒント」を提供するために使用されます。

フィールド
name

string

出力専用。ID。PhraseSet のリソース名。形式: projects/{project}/locations/{location}/phraseSets/{phrase_set}

uid

string

出力専用。システムによって割り当てられた PhraseSet の固有識別子。

phrases[]

Phrase

単語と語句のリスト。

boost

float

ヒント ブースト。正の値を指定すると、特定のフレーズが他の類似した発音のフレーズよりも認識される可能性が高くなります。ブーストが高いほど、誤検出の可能性も高くなります。有効な boost 値は 0(除く)~ 20 です。ユースケースに最適な値を見つけるには、バイナリ検索アプローチを使用し、ブーストありとなしの両方のフレーズをリクエストに追加することをおすすめします。

display_name

string

ユーザーが設定できる、人が読める形式の PhraseSet の名前。63 文字以下にしてください。

state

State

出力専用。PhraseSet のライフサイクル ステータス。

create_time

Timestamp

出力専用。作成時間。

update_time

Timestamp

出力専用。このリソースが最後に変更された時刻。

delete_time

Timestamp

出力専用。このリソースの削除がリクエストされた時刻。

expire_time

Timestamp

出力専用。このリソースがパージされる時刻。

annotations

map<string, string>

任意の少量のデータを保存できます。キーと値はそれぞれ 63 文字以下にする必要があります。アノテーションは最大 100 個まで。

etag

string

出力専用。このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されます。これは、更新リクエスト、削除取り消しリクエスト、削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

reconciling

bool

出力専用。この PhraseSet が更新中かどうか。

kms_key_name

string

出力専用。PhraseSet が暗号化される KMS 鍵の名前projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} という形式で指定してください。

kms_key_version_name

string

出力専用。PhraseSet が暗号化されている KMS 鍵バージョン名projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} という形式で指定してください。

フレーズ

Phrase には、音声認識で認識されやすくするための単語やフレーズの「ヒント」が含まれています。これは、特定の語句の精度を向上させるために使用できます。たとえば、ユーザーによって特定のコマンドがよく話されている場合が挙げられます。また、認識機能の語彙に語句を追加するためにも使用できます。

リスト項目には、自然言語で一般的な概念を表す単語のグループを含む CustomClass 参照を含めることもできます。

フィールド
value

string

フレーズ自体。

boost

float

ヒント ブースト。フレーズセット レベルで設定されたブーストをオーバーライドします。正の値を指定すると、特定のフレーズが他の類似した発音のフレーズよりも認識される可能性が高くなります。ブーストが高いほど、誤検出の可能性も高くなります。ブースト値が負の値の場合、バイアス除去に対応します。バイアス除去が有効になっていないため、負のブースト値はエラーを返します。ブースト値は 0 ~ 20 の範囲で指定する必要があります。この範囲外の値はエラーを返します。ユースケースに最適な値を見つけるには、バイナリ検索アプローチを使用し、ブーストありとなしの両方のフレーズをリクエストに追加することをおすすめします。

状態

PhraseSet のライフサイクルを定義する状態のセット。

列挙型
STATE_UNSPECIFIED 未指定の状態。これは、未設定の値を区別するためだけに使用され、役に立ちます。
ACTIVE 通常およびアクティブな状態。
DELETED この PhraseSet は削除されました。

RecognitionConfig

認識機能に認識リクエストの処理方法を指定する情報を提供します。

フィールド
model

string

省略可。認識リクエストに使用するモデル。最適な結果を得るには、ドメインに最適なモデルを選択してください。

使用するモデルの選択に関するガイダンスについては、文字起こしモデルのドキュメントをご覧ください。各リージョンでサポートされているモデルについては、サポートされているモデルの表をご覧ください。

language_codes[]

string

省略可。提供された音声の言語を、BCP-47 言語タグで表したもの。言語タグは、使用前に BCP-47 に正規化されます(例: 「en-us」は「en-US」になります)。

各モデルでサポートされている言語は、サポートされているモデルの表に記載されています。

追加の言語が指定されている場合、認識結果には検出された言語のうち最も可能性の高い言語での認識が含まれます。認識結果には、音声で検出された言語の言語タグが含まれます。

features

RecognitionFeatures

有効にする音声認識機能。

adaptation

SpeechAdaptation

特定の単語やフレーズの認識機能の予測に重み付けする音声適応コンテキスト。

transcript_normalization

TranscriptNormalization

省略可。文字起こし正規化を使用すると、文字起こしの部分を任意のフレーズに自動的に置き換えることができます。StreamingRecognize の場合、この正規化は安定した部分的な文字起こし(安定性 > 0.8)と最終的な文字起こしにのみ適用されます。

translation_config

TranslationConfig

省略可。サポートされているモデルで、指定された音声の翻訳を目的の言語に自動的に実行するために使用される省略可能な構成。

denoiser_config

DenoiserConfig

省略可。省略可能なノイズ除去機能の構成。一部のモデルではサポートされていない場合や、効果がない場合があります。

共用体フィールド decoding_config。認識のために送信される音声のデコード パラメータ。decoding_config は次のいずれかになります。
auto_decoding_config

AutoDetectDecodingConfig

デコード パラメータを自動的に検出します。サポートされている形式で推奨されます。

explicit_decoding_config

ExplicitDecodingConfig

明示的に指定されたデコード パラメータ。ヘッダーレス PCM オーディオ(linear16、mulaw、alaw)を使用する場合は必須です。

RecognitionFeatures

利用可能な認識機能。

フィールド
profanity_filter

bool

true に設定すると、サーバーは冒とく的な表現を除外します。除外された各単語の最初の文字以外はアスタリスクに置き換えられます(例: 「f***」)。false に設定するか省略した場合、冒とく的な表現はフィルタリングされません。

enable_word_time_offsets

bool

true の場合、最上位の結果に単語のリストと各単語の開始および終了時間オフセット(タイムスタンプ)が含まれます。false の場合、単語レベルの時間オフセット情報は返されません。デフォルトは false です。

enable_word_confidence

bool

true の場合、最上位の結果に単語のリストと各単語の信頼度が含まれます。false の場合、単語レベルの信頼度情報は返されません。デフォルトは false です。

enable_automatic_punctuation

bool

true の場合、認識結果の仮説に句読点を追加します。この機能は一部の言語でのみ使用できます。デフォルトの false 値では、結果の仮説に句読点は追加されません。

enable_spoken_punctuation

bool

通話の発話された句読点の動作です。true の場合、発話による句読点がリクエストの対応する記号に置き換えられます。たとえば、「お元気ですか疑問符」は「お元気ですか?」になります。サポートについては、https://cloud.google.com/speech-to-text/docs/spoken-punctuation をご覧ください。false の場合、発話された句読点は置き換えられません。

enable_spoken_emojis

bool

通話の発話された絵文字の動作です。true の場合、リクエストの発話された絵文字の形式が追加されます。最終的な文字起こしでは、発話された絵文字が対応する Unicode 記号に置き換えられます。false の場合、発話された絵文字は置き換えられません。

multi_channel_mode

MultiChannelMode

マルチチャンネル オーディオを認識するモード。

diarization_config

SpeakerDiarizationConfig

話者ダイアライゼーションを有効にする構成。ダイアライゼーションを有効にするには、このフィールドを空の SpeakerDiarizationConfig メッセージに設定します。

max_alternatives

int32

返される認識仮説の最大数。サーバーは max_alternatives より少ない値を返すことがあります。有効な値は 030 です。値が 0 または 1 の場合は、最大で 1 つが返されます。省略した場合、最大数は 1 になります。

MultiChannelMode

マルチチャンネル音声の認識方法に関するオプション。

列挙型
MULTI_CHANNEL_MODE_UNSPECIFIED マルチチャネル モードのデフォルト値。音声に複数のチャンネルが含まれている場合、最初のチャンネルのみが文字変換され、他のチャンネルは無視されます。
SEPARATE_RECOGNITION_PER_CHANNEL 選択すると、指定された音声の各チャンネルが個別に文字起こしされます。選択した modellatest_short の場合、これは選択できません。

RecognitionOutputConfig

認識の出力の構成オプション。

フィールド
output_format_config

OutputFormatConfig

省略可。output に保存される結果の形式の構成。指定しない場合、文字起こしは NATIVE 形式でのみ書き込まれます。

共用体フィールド output

output は次のいずれかになります。

gcs_output_config

GcsOutputConfig

このメッセージが入力されている場合、認識結果は指定された Google Cloud Storage URI に書き込まれます。

inline_response_config

InlineOutputConfig

このメッセージが入力されている場合、認識結果は完了時にオペレーションの BatchRecognizeResponse メッセージで提供されます。これは、1 つの音声ファイルのみで BatchRecognize を呼び出す場合にのみサポートされます。

RecognitionResponseMetadata

認識リクエストとレスポンスに関するメタデータ。

フィールド
request_id

string

API によって自動生成されたグローバル リクエスト識別子。

total_billed_duration

Duration

対応するリクエストの課金対象音声秒数(利用可能な場合)。

RecognizeRequest

Recognize メソッドに対するリクエスト メッセージ。content または uri を指定する必要があります。両方を指定するか、どちらも指定しないと INVALID_ARGUMENT が返されます。コンテンツの上限をご覧ください。

フィールド
recognizer

string

必須。認識中に使用する認識機能の名前。projects/{project}/locations/{location}/recognizers/{recognizer} という形式で指定してください。{recognizer} セグメントを _ に設定して、空の暗黙的な Recognizer を使用できます。

config

RecognitionConfig

自動音声認識に使用する特徴と音声メタデータ。このフィールドと config_mask フィールドを組み合わせて、Recognizer リソースの default_recognition_config の一部をオーバーライドできます。

config_mask

FieldMask

この認識リクエスト中に認識ツールの default_recognition_config の値をオーバーライドする config のフィールドのリスト。マスクが指定されていない場合、config のデフォルト値以外のフィールドはすべて、この認識リクエストの認識ツールの値よりも優先されます。マスクが指定されている場合、マスクにリストされているフィールドについてのみ、この認識リクエストの認識ツールの構成をオーバーライドします。ワイルドカード(*)を指定すると、config は、この認識リクエストの認識ツールの構成を完全にオーバーライドして置き換えます。

共用体フィールド audio_source。インライン コンテンツまたは Google Cloud Storage URI の音声ソース。audio_source は次のいずれかになります。
content

bytes

音声データのバイトは RecognitionConfig に指定されたとおりにエンコードされます。すべてのバイト フィールドと同様に、proto バッファでは純 2 進表現を使用し、JSON 表現では base64 を使用します。

uri

string

RecognitionConfig で指定された音声データバイトを含むファイルを指す URI。ファイルは圧縮しないでください(たとえば、gzip など)。現在サポートされているのは Google Cloud Storage URI のみです。これは gs://bucket_name/object_name の形式で指定する必要があります(他の URI 形式では INVALID_ARGUMENT が返されます)。詳細については、リクエスト URI をご覧ください。

RecognizeResponse

Recognize メソッドに対するレスポンス メッセージ。

フィールド
results[]

SpeechRecognitionResult

音声の連続する部分に対応する音声文字変換結果の連続するリスト。

metadata

RecognitionResponseMetadata

認識に関するメタデータ。

認識ツール

Recognizer メッセージ。認識構成とメタデータを保存します。

フィールド
name

string

出力専用。ID。Recognizer のリソース名。形式: projects/{project}/locations/{location}/recognizers/{recognizer}

uid

string

出力専用。システムによって割り当てられた Recognizer の固有識別子。

display_name

string

ユーザーが設定可能な、人が読める形式の Recognizer の名前。63 文字以下にしてください。

model
(deprecated)

string

省略可。このフィールドは非推奨になりました。RecognitionConfig メッセージの model フィールドを優先します。

認識リクエストに使用するモデル。最適な結果を得るには、ドメインに最適なモデルを選択してください。

使用するモデルの選択に関するガイダンスについては、文字起こしモデルのドキュメントをご覧ください。各リージョンでサポートされているモデルについては、サポートされているモデルの表をご覧ください。

language_codes[]
(deprecated)

string

省略可。このフィールドは非推奨になりました。RecognitionConfig メッセージの language_codes フィールドを優先します。

提供された音声の言語を、BCP-47 言語タグで表したもの。

各モデルでサポートされている言語は、サポートされているモデルの表に記載されています。

追加の言語が指定されている場合、認識結果には検出された言語のうち最も可能性の高い言語での認識が含まれます。認識結果には、音声で検出された言語の言語タグが含まれます。Recognizer を作成または更新すると、これらの値は正規化された BCP-47 形式で保存されます。たとえば、「en-us」は「en-US」として保存されます。

default_recognition_config

RecognitionConfig

この認識ツールを使用するリクエストに使用するデフォルトの構成。これは、RecognizeRequest.config フィールドのインライン構成によって上書きできます。

annotations

map<string, string>

任意の少量のデータを保存できます。キーと値はそれぞれ 63 文字以下にする必要があります。アノテーションは最大 100 個まで。

state

State

出力専用。Recognizer のライフサイクル ステータス。

create_time

Timestamp

出力専用。作成時間。

update_time

Timestamp

出力専用。この Recognizer が最後に変更された時刻。

delete_time

Timestamp

出力専用。この Recognizer の削除がリクエストされた時刻。

expire_time

Timestamp

出力専用。この Recognizer が削除される時刻。

etag

string

出力専用。このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されます。これは、更新リクエスト、削除取り消しリクエスト、削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

reconciling

bool

出力専用。この Recognizer が更新中かどうか。

kms_key_name

string

出力専用。Recognizer が暗号化される KMS 鍵の名前projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} という形式で指定してください。

kms_key_version_name

string

出力専用。Recognizer が暗号化されている KMS 鍵バージョン名projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} という形式で指定してください。

状態

Recognizer のライフサイクルを定義する状態のセット。

列挙型
STATE_UNSPECIFIED デフォルト値。この値は、状態が省略された場合に使用されます。
ACTIVE Recognizer が有効で、使用できる状態です。
DELETED この Recognizer は削除されています。

SpeakerDiarizationConfig

話者ダイアライゼーションを有効にする構成。

フィールド
min_speaker_count

int32

省略可。話者の数はシステムによって自動的に決定されます。この値は現在使用されていません。

max_speaker_count

int32

省略可。話者の数はシステムによって自動的に決定されます。この値は現在使用されていません。

SpeechAdaptation

結果の中の特定の語句を優先するように、音声認識機能に「ヒント」を提供します。PhraseSet は、インライン リソースとして指定することも、既存の PhraseSet リソースへの参照として指定することもできます。

フィールド
phrase_sets[]

AdaptationPhraseSet

インラインまたは参照される PhraseSet のリスト。

custom_classes[]

CustomClass

インライン CustomClass のリスト。既存の CustomClass リソースは、PhraseSet で直接参照できます。

AdaptationPhraseSet

バイアス設定の PhraseSet。既存の PhraseSets リソースの名前を参照する文字列、または PhraseSet のインライン定義のいずれかになります。

フィールド

共用体フィールド value

value は次のいずれかになります。

phrase_set

string

既存の PhraseSet リソースの名前。ユーザーにはリソースに対する読み取りアクセス権が必要であり、リソースが削除されていない必要があります。

inline_phrase_set

PhraseSet

インラインで定義された PhraseSet。

SpeechRecognitionAlternative

別の仮説(n-best リストとも呼ばれる)。

フィールド
transcript

string

ユーザーが話した単語を表す音声文字変換テキスト。

confidence

float

信頼度の推定値は 0.0~1.0。数値が大きいほど、認識された単語が正しい可能性が高くなります。このフィールドは、ストリーミング以外の結果の最上位の候補、または is_finaltrue に設定されているストリーミング結果の最上位の候補に対してのみ設定されます。このフィールドは正確であることが保証されていません。また、ユーザーはこのフィールドが常に提供されることを前提にしないでください。デフォルトの 0.0 は、confidence が設定されなかったことを示す標識値です。

words[]

WordInfo

認識された各単語の、単語固有の情報のリスト。SpeakerDiarizationConfig を設定すると、音声の最初からすべての単語が表示されます。

SpeechRecognitionResult

音声の一部に対応する音声認識の結果。

フィールド
alternatives[]

SpeechRecognitionAlternative

1 つ以上の認識仮説が含まれる場合があります。これらの候補は認識機能によってランク付けされた正確さの順に並んでおり、最も確度の高い候補が最上位(最初)に位置します。

channel_tag

int32

マルチチャンネル音声の場合、これはそのチャンネルからの音声の認識結果に対応するチャンネル番号です。 audio_channel_count = N の場合、出力値の範囲は 1 から N までです。

result_end_offset

Duration

音声の先頭から相対的な、この結果の終了時点の時間オフセット。

language_code

string

出力専用。この結果の言語の BCP-47 言語タグ。この言語コードは、音声内で話された可能性が高いと検出されたものです。

SrtOutputFileFormatConfig

この型にはフィールドがありません。

出力構成は、SubRip Text 形式の字幕ファイルです。

StreamingRecognitionConfig

StreamingRecognize リクエストの構成情報を提供します。

フィールド
config

RecognitionConfig

必須。自動音声認識に使用する特徴と音声メタデータ。このフィールドと config_mask フィールドを組み合わせて、Recognizer リソースの default_recognition_config の一部をオーバーライドできます。

config_mask

FieldMask

この認識リクエスト中に認識ツールの default_recognition_config の値をオーバーライドする config のフィールドのリスト。マスクが指定されていない場合、config のデフォルト値以外のフィールドはすべて、この認識リクエストの認識ツールの値よりも優先されます。マスクが指定されている場合、マスクにリストされているフィールドについてのみ、この認識リクエストの認識ツールの構成をオーバーライドします。ワイルドカード(*)を指定すると、config は、この認識リクエストの認識ツールの構成を完全にオーバーライドして置き換えます。

streaming_features

StreamingRecognitionFeatures

ストリーミング音声認識リクエストに固有の音声認識機能。

StreamingRecognitionFeatures

ストリーミング認識リクエストに固有の利用可能な認識機能。

フィールド
enable_voice_activity_events

bool

true の場合、音声アクティビティ音声イベントを含むレスポンスは、検出されたときに返されます。

interim_results

bool

中間結果をクライアントにストリーミングするかどうか。true に設定すると、中間結果がクライアントにストリーミングされます。それ以外の場合は、最終的なレスポンスのみがストリーミングで返されます。

voice_activity_timeout

VoiceActivityTimeout

設定されている場合、サーバーは最後の VOICE_ACTIVITY 音声イベントが送信されてから指定された時間が経過すると、ストリームを自動的に閉じます。voice_activity_events フィールドも true に設定する必要があります。

VoiceActivityTimeout

音声アクティビティのタイムアウトを設定できるイベント。

フィールド
speech_start_timeout

Duration

音声が開始されない場合にストリームをタイムアウトするまでの時間。これが設定されていて、ストリームの開始時にこの期間内に音声が検出されない場合、サーバーはストリームを閉じます。

speech_end_timeout

Duration

音声が終了してからストリームがタイムアウトするまでの時間。これが設定されていて、音声が検出された後にこの期間内に音声が検出されない場合、サーバーはストリームを閉じます。

StreamingRecognitionResult

現在処理されている音声の部分に対応するストリーミング音声認識の結果。

フィールド
alternatives[]

SpeechRecognitionAlternative

1 つ以上の認識仮説が含まれる場合があります。これらの候補は認識機能によってランク付けされた正確さの順に並んでおり、最も確度の高い候補が最上位(最初)に位置します。

is_final

bool

false の場合、この StreamingRecognitionResult は変更される可能性がある中間結果を表します。true の場合、これは音声サービスが特定の StreamingRecognitionResult を返す最後の機会であり、認識機能が変換テキストと対応する音声のこの部分に対して、これ以上の仮説が返されることはありません。

stability

float

認識機能でこの暫定的な結果についての推測が変更されない可能性の推定値。値の範囲は 0.0(完全に不安定)~1.0(完全に安定)です。このフィールドは、中間結果(is_final=false)でのみ使用できます。デフォルトの 0.0 は、stability が設定されなかったことを示す標識値です。

result_end_offset

Duration

音声の先頭から相対的な、この結果の終了時点の時間オフセット。

channel_tag

int32

マルチチャンネル音声の場合、これはそのチャンネルからの音声の認識結果に対応するチャンネル番号です。 audio_channel_count = N の場合、出力値の範囲は 1 から N までです。

language_code

string

出力専用。この結果の言語の BCP-47 言語タグ。この言語コードは、音声内で話された可能性が高いと検出されたものです。

StreamingRecognizeRequest

StreamingRecognize メソッドに対するリクエスト メッセージ。複数の StreamingRecognizeRequest メッセージが 1 回の呼び出しで送信されます。

recognizer で参照される Recognizer に完全に指定されたリクエスト構成が含まれている場合、ストリームには audio のみが設定されたメッセージのみが含まれることがあります。

それ以外の場合、最初のメッセージには、リクエスト構成を完全に指定する recognizer メッセージと streaming_config メッセージが含まれている必要があり、audio を含めることはできません。後続のすべてのメッセージは、audio のみが設定されている必要があります。

フィールド
recognizer

string

必須。認識中に使用する認識機能の名前。projects/{project}/locations/{location}/recognizers/{recognizer} という形式で指定してください。{recognizer} セグメントを _ に設定して、空の暗黙的な Recognizer を使用できます。

共用体フィールド streaming_request

streaming_request は次のいずれかになります。

streaming_config

StreamingRecognitionConfig

この認識試行で使用する StreamingRecognitionConfig。指定すると、認識ツールに保存されているデフォルトの RecognitionConfig がオーバーライドされます。

audio

bytes

認識するインライン音声バイト。このフィールドの最大サイズはリクエストあたり 15 KB です。

StreamingRecognizeResponse

StreamingRecognizeResponse は、StreamingRecognize によってクライアントに返される唯一のメッセージです。一連のゼロ個以上の StreamingRecognizeResponse メッセージがクライアントにストリーミングされます。認識可能な音声がない場合、メッセージはクライアントにストリーミングされません。

音声の処理中に返される StreamingRecognizeResponse の例を次に示します。

  1. results { alternatives { transcript: "tube" } stability: 0.01 }

  2. results { alternatives { transcript: "to be a" } stability: 0.01 }

  3. results { alternatives { transcript: "to be" } stability: 0.9 } results { alternatives { transcript: " or not to be" } stability: 0.01 }

  4. results { alternatives { transcript: "to be or not to be" confidence: 0.92 } alternatives { transcript: "to bee or not to bee" } is_final: true }

  5. results { alternatives { transcript: " that's" } stability: 0.01 }

  6. results { alternatives { transcript: " that is" } stability: 0.9 } results { alternatives { transcript: " the question" } stability: 0.01 }

  7. results { alternatives { transcript: " that is the question" confidence: 0.98 } alternatives { transcript: " that was the question" } is_final: true }

注:

  • 上記のレスポンスのうち、#4 と #7 の 2 つにのみ最終結果が含まれます。これらは is_final: true で示されています。これらの結果を連結することで、完全な音声文字変換テキスト「to be or not to be that is the question」が生成されます。

  • その他には中間 results が含まれています。#3 と #6 には 2 つの暫定的 results が含まれています。最初の部分は安定性が高く、変更される可能性は低くなります。2 つ目の部分は安定性が低く、変更される可能性が高くなります。UI デザイナーは、安定性の高い results のみを表示することを選択する場合があります。

  • 上記の stabilityconfidence の値は、説明のみを目的としています。実際の値はこれとは異なる場合があります。

  • 各レスポンスでは、次のフィールドの1つのみが設定されます: errorspeech_event_type、または 1 つ以上の(繰り返し)results

フィールド
results[]

StreamingRecognitionResult

この繰り返しリストには、現在処理されている音声の連続する部分に対応する、ゼロ個以上の結果が含まれます。ゼロまたは 1 つの is_final=true 結果(新しく解決された部分)に続いて、ゼロまたはそれ以上の is_final=false 結果(暫定的結果)が続きます。

speech_event_type

SpeechEventType

speech イベントのタイプを示します。

speech_event_offset

Duration

音声の開始とイベント出力の間のタイム オフセット。

metadata

RecognitionResponseMetadata

認識に関するメタデータ。

SpeechEventType

speech イベントのタイプを示します。

列挙型
SPEECH_EVENT_TYPE_UNSPECIFIED speech イベントが指定されていません。
END_OF_SINGLE_UTTERANCE このイベントは、サーバーがユーザーの発話の終わりを検出し、これ以上発話が続くことはないと推測したことを示します。したがって、サーバーは追加の音声を処理せず、gRPC 双方向ストリームを閉じます。このイベントは、無音状態が早期に検出されたために強制的にカットオフされた場合にのみ送信されます。このイベントは、latest_short model を通じてのみ利用できます。
SPEECH_ACTIVITY_BEGIN このイベントは、サーバーがストリーム内の人間の音声アクティビティの開始を検出したことを示します。ストリーム全体で音声の開始と停止が繰り返される場合、このイベントが複数回返されることがあります。このイベントは、voice_activity_events が true に設定されている場合にのみ送信されます。
SPEECH_ACTIVITY_END このイベントは、サーバーがストリーム内の人間の音声アクティビティの終了を検出したことを示します。ストリーム全体で音声の開始と停止が繰り返される場合、このイベントが複数回返されることがあります。このイベントは、voice_activity_events が true に設定されている場合にのみ送信されます。

TranscriptNormalization

文字起こし正規化の構成。文字起こし正規化を使用すると、文字起こしの部分を任意のフレーズに自動的に置き換えることができます。StreamingRecognize の場合、この正規化は安定した部分的な文字起こし(安定性 > 0.8)と最終的な文字起こしにのみ適用されます。

フィールド
entries[]

Entry

置換エントリのリスト。交換は 1 回のエントリで 1 つずつ行います。たとえば、["cat" => "dog", "mountain cat" => "mountain dog"] の 2 番目のエントリは、常に最初のエントリが処理されるため、適用されません。最大 100 個のエントリ。

エントリ

単一の置換構成。

フィールド
search

string

置き換える内容。最大長は 100 文字です。

replace

string

置き換える内容。最大長は 100 文字です。

case_sensitive

bool

検索で大文字と小文字が区別されるかどうか。

TranslationConfig

変換の構成。指定された音声を目的の言語のテキストに変換するために使用します。

フィールド
target_language

string

必須。翻訳先の言語コード。

UndeleteCustomClassRequest

UndeleteCustomClass メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。削除を取り消す CustomClass の名前。形式: projects/{project}/locations/{location}/customClasses/{custom_class}

validate_only

bool

設定されている場合、リクエストを検証し、削除されていない CustomClass をプレビューしますが、実際には削除されません。

etag

string

このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されます。これは、更新リクエスト、削除取り消しリクエスト、削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

UndeletePhraseSetRequest

UndeletePhraseSet メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。削除を取り消す PhraseSet の名前。形式: projects/{project}/locations/{location}/phraseSets/{phrase_set}

validate_only

bool

設定されている場合、リクエストを検証し、削除されていない PhraseSet をプレビューしますが、実際には削除を解除しません。

etag

string

このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されます。これは、更新リクエスト、削除取り消しリクエスト、削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

UndeleteRecognizerRequest

UndeleteRecognizer メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。削除を取り消す Recognizer の名前。形式: projects/{project}/locations/{location}/recognizers/{recognizer}

validate_only

bool

設定されている場合、リクエストを検証し、削除されていない Recognizer をプレビューしますが、実際には削除を解除しません。

etag

string

このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されます。これは、更新リクエスト、削除取り消しリクエスト、削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

UpdateConfigRequest

UpdateConfig メソッドに対するリクエスト メッセージ。

フィールド
config

Config

必須。更新する構成。

構成の name フィールドは、更新する構成を識別するために使用されます。projects/{project}/locations/{location}/config という形式で指定してください。

update_mask

FieldMask

更新するフィールドのリスト。

UpdateCustomClassRequest

UpdateCustomClass メソッドに対するリクエスト メッセージ。

フィールド
custom_class

CustomClass

必須。更新する CustomClass。

CustomClass の name フィールドは、更新する CustomClass を識別するために使用されます。形式: projects/{project}/locations/{location}/customClasses/{custom_class}

update_mask

FieldMask

更新するフィールドのリスト。空の場合、すべてのフィールドが更新の対象となります。

validate_only

bool

設定されている場合、リクエストを検証し、更新された CustomClass をプレビューしますが、実際には更新しません。

UpdatePhraseSetRequest

UpdatePhraseSet メソッドに対するリクエスト メッセージ。

フィールド
phrase_set

PhraseSet

必須。更新する PhraseSet。

PhraseSet の name フィールドは、更新する PhraseSet を識別するために使用されます。形式: projects/{project}/locations/{location}/phraseSets/{phrase_set}

update_mask

FieldMask

更新するフィールドのリスト。空の場合、デフォルト値以外のすべてのフィールドが更新の対象となります。* を使用して PhraseSet リソース全体を更新します。

validate_only

bool

設定されている場合、リクエストを検証し、更新された PhraseSet をプレビューしますが、実際には更新しません。

UpdateRecognizerRequest

UpdateRecognizer メソッドに対するリクエスト メッセージ。

フィールド
recognizer

Recognizer

必須。更新する認識ツール。

Recognizer の name フィールドは、更新する Recognizer を識別するために使用されます。形式: projects/{project}/locations/{location}/recognizers/{recognizer}

update_mask

FieldMask

更新するフィールドのリスト。空の場合、デフォルト値以外のすべてのフィールドが更新の対象となります。* を使用して、Recognizer リソース全体を更新します。

validate_only

bool

設定されている場合、リクエストを検証し、更新された Recognizer をプレビューしますが、実際には更新しません。

VttOutputFileFormatConfig

この型にはフィールドがありません。

WebVTT 形式の字幕ファイルの出力構成。

WordInfo

認識された単語の単語固有の情報。

フィールド
start_offset

Duration

単語の発話の開始時点に対応する、音声の先頭からの相対的な時間オフセット。このフィールドは、enable_word_time_offsetstrue であり、かつ最上位の仮説にのみ設定されます。これは試験運用中の機能であり、時間オフセットの精度は変更される可能性があります。

end_offset

Duration

単語の発話の終了時点に対応する、音声の先頭からの相対的な時間オフセット。このフィールドは、enable_word_time_offsetstrue であり、かつ最上位の仮説にのみ設定されます。これは試験運用中の機能であり、時間オフセットの精度は変更される可能性があります。

word

string

この情報セットに対応する単語。

confidence

float

信頼度の推定値は 0.0~1.0。数値が大きいほど、認識された単語が正しい可能性が高くなります。このフィールドは、ストリーミング以外の結果の最上位の候補、または is_finaltrue に設定されているストリーミング結果の最上位の候補に対してのみ設定されます。このフィールドは正確であることが保証されていません。また、ユーザーはこのフィールドが常に提供されることを前提にしないでください。デフォルトの 0.0 は、confidence が設定されなかったことを示す標識値です。

speaker_label

string

音声内の各話者に個別のラベルが割り当てられます。このフィールドは、この単語を発したと検出されたのが、話者のうちの誰であるかを指定します。speaker_label は、SpeakerDiarizationConfig が指定されている場合にのみ、最上位の代替案に設定されます。