Skip to main content

カスタム語彙 HTTP API リファレンス

HTTP API を使用して、カスタム語彙の作成、一覧表示、取得、更新、削除などの操作を実行できます。

ユーザーガイド： 認識精度の向上。
カスタム語彙はプライマリワークスペースでのみサポートされます。サブワークスペースではサポートされません。

エンドポイント

  • シンガポール
  • 中国 (北京)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization{WorkspaceId} は、ご利用のワークスペース IDに置き換えてください。
Alibaba Cloud Model Studio は、中国 (北京) リージョンおよびシンガポールリージョン向けにワークスペース固有のドメインをリリースしました。新しい専用ドメインは、推論リクエストに対して優れたパフォーマンスと高い安定性を提供します。以下の新しいドメインへの移行を推奨します。
  • 中国 (北京)： dashscope.aliyuncs.com から {WorkspaceId}.cn-beijing.maas.aliyuncs.com へ
  • シンガポール： dashscope-intl.aliyuncs.com から {WorkspaceId}.ap-southeast-1.maas.aliyuncs.com へ
{WorkspaceId} は、ご利用のワークスペース IDに置き換えてください。既存のドメインは引き続き完全に機能します。

リクエストヘッダー

パラメーター

タイプ

必須

説明

Authorization

string

はい

Bearer トークン。形式は Bearer <api_key> です。ここで、<api_key> はご利用の API キーです。

Content-Type

string

はい

リクエストボディのメディアタイプ。 application/json に設定してください。

語彙の作成

リクエストボディ

modelstring(必須)カスタム語彙モデル。 speech-biasing に設定してください。inputobject(必須)入力パラメーター。

プロパティ

action string(必須)操作タイプ。 create_vocabulary に設定してください。target_model string(必須)この語彙を使用する音声認識モデル。この値は、音声認識 API を呼び出す際に指定するモデルと一致している必要があります。prefix string(必須)語彙のカスタムプレフィックス。小文字と数字のみが使用可能で、最大長は 10 文字です。vocabulary array[object](必須)語彙エントリの配列。

プロパティ

text string(必須)語彙エントリのテキスト。テキストの言語は、選択したモデルでサポートされている必要があります。サポートされる言語はモデルによって異なります。認識精度を向上させるには、任意の文字の組み合わせではなく、実際の単語を使用してください。最大長：非 ASCII 文字を含むテキストの場合は 15 文字、ASCII のみのテキストの場合はスペースで区切られた 7 単語。weight integer(必須)語彙エントリの重み。推奨値：4。有効な値：1 ～ 5。認識精度が向上しない場合は、重みを増やしてください。ただし、重みが高すぎると他の単語の認識精度が低下する可能性があります。lang string(オプション)認識対象の音声の言語コード。設定すると、指定された言語の語彙エントリの認識が向上します。事前に言語を特定できない場合は、このパラメーターを設定しないでください。モデルが自動的に言語を検出します。有効な値（モデルによって異なります）：
  • Paraformer：
    • zh：中国語
    • en：英語
    • ja：日本語
    • yue：広東語
    • ko：韓国語
    • de：ドイツ語
    • fr：フランス語
    • ru：ロシア語
  • Fun-ASR：
    • zh：中国語
    • en：英語
    • ja：日本語
以下の URL はシンガポールリージョン用です。WorkspaceId は、ご利用のワークスペース ID に置き換えてください。URL はリージョンによって異なります。シンガポールリージョンと北京リージョンの API キーは異なります。詳細については、「API キーの取得」をご参照ください。
curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "create_vocabulary",
        "target_model": "fun-asr",
        "prefix": "testpfx",
        "vocabulary": [
          {"text": "Seediq Bale", "weight": 4}
        ]
    }
}'

レスポンスボディ

request_idstringこのリクエストの一意な識別子。outputobjectレスポンスデータ。

プロパティ

vocabulary_idstring作成された語彙の ID。
usageobjectこのリクエストの使用量情報。

プロパティ

count integer作成された語彙の数。常に 1。
{
    "output": {
        "vocabulary_id": "vocab-testpfx-5112c3de3705486baxxxxxxx"
    },
    "usage": {
        "count": 1
    },
    "request_id": "aee47022-2352-40fe-acfa-xxxx"
}

語彙の一覧表示

リクエストボディ

modelstring(必須)カスタム語彙モデル。 speech-biasing に設定してください。inputobject(必須)入力パラメーター。

プロパティ

action string(必須)操作タイプ。 list_vocabulary に設定してください。prefix string(オプション)語彙のカスタムプレフィックス。指定した場合、このプレフィックスを持つ語彙のみが返されます。page_index integerページ番号（0 から開始）。デフォルト値：0。page_size integer1 ページあたりのエントリ数。デフォルト値：10。
以下の URL はシンガポールリージョン用です。WorkspaceId は、ご利用のワークスペース ID に置き換えてください。URL はリージョンによって異なります。シンガポールリージョンと北京リージョンの API キーは異なります。詳細については、「API キーの取得」をご参照ください。
curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "list_vocabulary",
        "prefix": "testpfx",
        "page_index": 0,
        "page_size": 10
    }
}'

レスポンスボディ

request_idstringこのリクエストの一意な識別子。outputobjectレスポンスデータ。

プロパティ

vocabulary_listarray[object]照会された語彙。

プロパティ

vocabulary_idstring語彙 ID。gmt_createstring作成時刻。gmt_modifiedstring最終更新時刻。statusstringステータス：
  • OK：準備完了。
  • UNDEPLOYED：利用不可。
usageobjectこのリクエストの使用量情報。

プロパティ

count integer常に 1。
{
    "output": {
        "vocabulary_list": [
            {
                "gmt_create": "2026-03-02 18:07:38",
                "gmt_modified": "2026-03-02 18:07:38",
                "status": "OK",
                "vocabulary_id": "vocab-ciotest-8e74bef2accf4xxxxxxxx"
            },
            {
                "gmt_create": "2026-02-27 19:04:48",
                "gmt_modified": "2026-02-28 13:40:40",
                "status": "OK",
                "vocabulary_id": "vocab-sifasr-f483ad46e1844fxxxxxxxx"
            }
        ]
    },
    "usage": {
        "count": 1
    },
    "request_id": "81d51a05-8cdd-45c0-973f-xxxxxxxx"
}

語彙の取得

リクエストボディ

modelstring(必須)カスタム語彙モデル。 speech-biasing に設定してください。inputobject(必須)入力パラメーター。

プロパティ

action string(必須)操作タイプ。 query_vocabulary に設定してください。vocabulary_id string(必須)取得する語彙の ID。
以下の URL はシンガポールリージョン用です。WorkspaceId は、ご利用のワークスペース ID に置き換えてください。URL はリージョンによって異なります。シンガポールリージョンと北京リージョンの API キーは異なります。詳細については、「API キーの取得」をご参照ください。
curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "query_vocabulary",
        "vocabulary_id": "vocab-testpfx-xxxx"
    }
}'

レスポンスボディ

request_idstringこのリクエストの一意な識別子。outputobjectレスポンスデータ。

プロパティ

gmt_createstring作成時刻。gmt_modifiedstring最終更新時刻。statusstringステータス：
  • OK：準備完了。
  • UNDEPLOYED：利用不可。
target_model stringこの語彙を使用する音声認識モデル。この値は、音声認識 API を呼び出す際に指定するモデルと一致している必要があります。vocabularyarray[object]照会された語彙。

プロパティ

text string語彙エントリのテキスト。weight integer語彙エントリの重み。lang string認識対象の音声の言語。
usageobjectこのリクエストの使用量情報。

プロパティ

count integer常に 1。
{
  "output": {
    "gmt_create": "2025-12-19 11:47:11",
    "gmt_modified": "2025-12-19 11:47:11",
    "status": "OK",
    "target_model": "fun-asr",
    "vocabulary": [
      {
        "lang": "en",
        "text": "Seediq Bale",
        "weight": 4
      }
    ]
  },
  "usage": {
    "count": 1
  },
  "request_id": "3d461d3f-b2c4-4de5-xxxx"
}

語彙の更新

リクエストボディ

modelstring(必須)カスタム語彙モデル。 speech-biasing に設定してください。inputobject(必須)入力パラメーター。

プロパティ

action string(必須)操作タイプ。 update_vocabulary に設定してください。vocabulary_id string(必須)更新する語彙の ID。vocabulary array[object](必須)新しい語彙。これにより、既存のエントリが完全に置き換えられます。

プロパティ

text string(必須)語彙エントリのテキスト。テキストの言語は、選択したモデルでサポートされている必要があります。サポートされる言語はモデルによって異なります。認識精度を向上させるには、任意の文字の組み合わせではなく、実際の単語を使用してください。最大長：非 ASCII 文字を含むテキストの場合は 15 文字、ASCII のみのテキストの場合はスペースで区切られた 7 単語。weight integer(必須)語彙エントリの重み。推奨値：4。有効な値：1 ～ 5。認識精度が向上しない場合は、重みを増やしてください。ただし、重みが高すぎると他の単語の認識精度が低下する可能性があります。lang string(オプション)認識対象の音声の言語コード。設定すると、指定された言語の語彙エントリの認識が向上します。事前に言語を特定できない場合は、このパラメーターを設定しないでください。モデルが自動的に言語を検出します。有効な値（モデルによって異なります）：
  • Paraformer：
    • zh：中国語
    • en：英語
    • ja：日本語
    • yue：広東語
    • ko：韓国語
    • de：ドイツ語
    • fr：フランス語
    • ru：ロシア語
  • Fun-ASR：
    • zh：中国語
    • en：英語
    • ja：日本語
以下の URL はシンガポールリージョン用です。WorkspaceId は、ご利用のワークスペース ID に置き換えてください。URL はリージョンによって異なります。シンガポールリージョンと北京リージョンの API キーは異なります。詳細については、「API キーの取得」をご参照ください。
curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "update_vocabulary",
        "vocabulary_id": "vocab-testpfx-xxx",
        "vocabulary": [
          {"text": "Seediq Bale", "weight": 4, "lang": "en"}
        ]
    }
}'

レスポンスボディ

request_idstringこのリクエストの一意な識別子。outputobjectレスポンスデータ。常に空です。usageobjectこのリクエストの使用量情報。

プロパティ

count integer更新された語彙の数。常に 1。
{
  "output": {},
  "usage": {
    "count": 1
  },
  "request_id": "aee47022-2352-40fe-acfa-xxxx"
}

語彙の削除

リクエストボディ

modelstring(必須)カスタム語彙モデル。 speech-biasing に設定してください。inputobject(必須)入力パラメーター。

プロパティ

action string(必須)操作タイプ。 delete_vocabulary に設定してください。vocabulary_id string(必須)削除する語彙の ID。
以下の URL はシンガポールリージョン用です。WorkspaceId は、ご利用のワークスペース ID に置き換えてください。URL はリージョンによって異なります。シンガポールリージョンと北京リージョンの API キーは異なります。詳細については、「API キーの取得」をご参照ください。
curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "delete_vocabulary",
        "vocabulary_id": "vocab-testpfx-xxx"
    }
}'

レスポンスボディ

request_idstringこのリクエストの一意な識別子。outputobjectレスポンスデータ。常に空です。usageobjectこのリクエストの使用量情報。

プロパティ

count integer削除された語彙の数。常に 1。
{
  "output": {},
  "usage": {
    "count": 1
  },
  "request_id": "aee47022-2352-40fe-acfa-xxxx"
}