Cloud API (Json)

単語辞書の作成

基本情報

Path： /v1/hotwords

Method： POST

APIの説明： 単語リストをアップロードして、単語辞書を作成します。単語辞書の作成に上限はありません。手動で単語を抽出する場合、各単語/読みの最大文字数は30文字、1つの辞書は20000単語以内です。

自動で単語を抽出する場合、テキスト内容は100万文字を超えてはいけません（自動抽出は現在、中国語および中英混合の言語のみ対応しています）。

不適切な単語は、プラットフォームによって自動的にフィルタリングされます。フィルタリング条件:

1列または2列のみが存在する場合（日本語および日英混合の言語のみ適用）
クラスがドロップダウンリストの値に含まれていない
すべてが句読点のみ
文字数制限を超えている
絵文字や特殊文字を含んでいる
内容が空である
重複項目
読みがひらがなまたは全角カタカナで入力されていない
1列を超える場合（英語&中国語&中英混合の言語のみ適用）

リクエストパラメータ

Body（json）

名前	タイプ	必須	説明	デフォルト値
name	string	いいえ	単語辞書名	空
lang_type	string	はい	言語、開発ガイド-言語サポートを参照してください	Null
words	list<string>	はい	単語リスト言語に応じて異なるフォーマットを設定します。日本語/日英混合：`["表記,読み,クラス", "表記,読み,クラス", ...]` 中国語/中英混合/英語：`["表記", "表記", ...]`	Null
auto_extraction	boolean	いいえ	単語リストの内容から自動的にキーワードを抽出するかどうか。現在、中国語および中英混合の言語のみ対応しています。	false
id	string	いいえ	単語辞書ID。数字、英字（大文字と小文字を区別しない）、アンダースコア、ハイフンのみ（`[a-zA-Z0-9_-]`）がサポートされています。長さは150文字を超えてはいけません。 IDを指定しない場合は、システムが自動的にIDを生成します。	Null

レスポンスパラメータ

名前	タイプ	説明
status	string	ステータスコード
message	string	ステータスコードの説明
data	object	データ
├─ id	string	単語辞書ID

リクエスト例

手動で単語を抽出し、リストの各要素は 1 つの単語です。

curl --location 'https://api.voice.dolphin-ai.jp/v1/hotwords' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
    "name": "test",
    "lang_type": "ja-JP",
    "words": ["早稲田大学,ワセダダイガク,固有名詞","新横浜,シンヨコハマ,地名"]
}'

自動で単語を抽出し、文書の内容は1つの要素でも複数の要素でも良い、auto_extraction パラメータを true に設定する必要があります。

curl --location 'https://api.voice.dolphin-ai.jp/v1/hotwords' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
    "name": "test1",
    "lang_type": "zh-cmn-Hans-CN",
    "auto_extraction": true,
    "words": [
        "中国第40次南极考察内陆队北京时间16日在中山站举行出征仪式，29名队员将分别前往泰山站、昆仑站和格罗夫山地区，开展相关科学考察。",
        "本次考察由自然资源部组织。这是中国首次派出3艘船执行南极考察任务，即雪龙号、雪龙二号和天惠轮。"
    ]
}'

レスポンス例

{
    "status": "000000",
    "message": "Success",
    "data": {
        "id": "HW3D0F1284"
    }
}

単語辞書の削除

基本情報

Path： /v1/hotwords/{hotwords_id}

Method： DELETE

APIの説明： 指定されたIDの単語辞書を削除します。現在認識リクエストが呼び出されていない辞書のみ削除できます。

リクエスト例

curl --location --request DELETE 'https://api.voice.dolphin-ai.jp/v1/hotwords/HWA3B0FD4F' \
--header 'Authorization: ••••••'

レスポンス例

{
    "status": "00000",
    "message": "success",
    "data": null
}

レスポンスパラメータ

名前	タイプ	説明
status	string	ステータスコード
message	string	ステータスコードの説明
data	object	無し

単語辞書情報リストの取得

基本情報

Path： /v1/hotwords

Method： GET

APIの説明： 全ての単語辞書情報を取得します。

リクエストパラメータ

名前	タイプ	必須	説明	デフォルト値
name	string	いいえ	単語辞書名または単語辞書ID	無し
lang_type	string	いいえ	言語	無し
page_size	int	いいえ	1ページあたりの項目数、最大100	10
page_index	int	いいえ	ページ番号	1

レスポンスパラメータ

名前	タイプ	説明
status	string	ステータスコード
message	string	ステータスコードの説明
data	object	データ
├─ amount	int	フィルタ条件に合致する単語辞書の数（単語辞書名やID、言語のフィルタリングが行われた場合）
├─ used	int	単語辞書の総数
├─ list	object[]
├─├─ id	string	単語辞書ID
├─├─ name	string	単語辞書名
├─├─ lang_type	string	言語
├─├─ status	int	ステータス 0: 未使用 1: 使用中
├─├─ amount	int	単語数
├─├─ update_time	string	最終更新時間

リクエスト例

curl --location 'https://api.voice.dolphin-ai.jp/v1/hotwords' \
--header 'Authorization: ••••••'

レスポンス例

{
    "status": "000000",
    "message": "Success",
    "data": {
        "list": [
            {
                "id": "HWF21FA445",
                "name": "xxx",
                "lang_type": "ja-JP",
                "status": 0,
                "amount": 2,
                "updated_time": "2025-02-10 17:23:01"
            }
        ],
        "amount": 13,
        "used": 13
    }
}

単語辞書情報の取得

基本情報

Path： /v1/hotwords/{hotwords_id}

Method： GET

APIの説明： 指定されたIDの単語辞書の情報を取得します。

レスポンスパラメータ

名前	タイプ	説明
status	string	ステータスコード
message	string	ステータスコードの説明
data	object	データ
├─ id	string	単語辞書ID
├─ name	string	単語辞書名
├─ lang_type	string	言語
├─ status	int	ステータス 0: 未使用 1: 使用中
├─ update_time	string	最終更新時間
├─ words	list<string>	単語リスト
├─ amount	int	単語数

リクエスト例

curl --location 'https://api.voice.dolphin-ai.jp/v1/hotwords/HW09A3ECA7' \
--header 'Authorization: ••••••'

レスポンス例

{
    "status": "000000",
    "message": "Success",
    "data": {
        "id": "HW09A3ECA7",
        "name": "123",
        "lang_type": "ja-JP",
        "status": 0,
        "updated_time": "2025-01-03 13:12:34",
        "words": [
            "早稲田大学,ワセダダイガク,固有名詞",
            "新横浜,シンヨコハマ,地名"
        ],
        "amount": 2
    }
}

単語辞書情報の変更

基本情報

Path： /v1/hotwords/{hotwords_id}

Method： PUT

APIの説明： 既存の単語辞書名または単語リストを変更します。注意：単語リストを変更する場合、辞書内の全ての単語が新しいリストの内容で上書きされます。単語を追加する場合は、単語の追加APIを使用してください。

リクエストパラメータ

Body（json）

名前	タイプ	必須	説明	デフォルト値
name	string	いいえ	単語辞書名	無し
words	list<string>	いいえ	単語リスト	無し
auto_extraction	boolean	いいえ	単語リストの内容から自動的にキーワードを抽出するかどうか（現在、中国語および中英混合の言語のみ対応しています。）	false

レスポンスパラメータ

名前	タイプ	説明
status	string	ステータスコード
message	string	ステータスコードの説明
data	object	データ
├─ id	string	単語辞書ID

リクエスト例

curl --location --request PUT 'https://api.voice.dolphin-ai.jp/v1/hotwords/HWCFCB0FF0' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
    "name": "123",
    "words": ["早稲田大学,ワセダダイガク,固有名詞"]
}'

上記の例では、辞書名を変更し、単語内容も更新しました。もし辞書名のみを変更する場合は、words パラメータを渡す必要はありません。逆も同様です。

レスポンス例

{
    "status": "000000",
    "message": "Success",
    "data": {
        "id": "HWCFCB0FF0"
    }
}

単語の追加

基本情報

Path： /v1/hotwords/{hotwords_id}

Method： POST

APIの説明： 既存の単語辞書に単語を追加します。各単語は30文字以内、1つの辞書は20000単語以内です。

リクエストパラメータ

Body（json）

名前	タイプ	必須	説明	デフォルト値
words	list<string>	是	単語リスト	必須
auto_extraction	boolean	否	単語リストの内容から自動的にキーワードを抽出するかどうか（現在、中国語および中英混合の言語のみ対応しています。）	false

レスポンスパラメータ

名前	タイプ	説明
status	string	ステータスコード
message	string	ステータスコードの説明
data	int	現在の辞書内の単語数

リクエスト例

curl --location 'https://api.voice.dolphin-ai.jp/v1/hotwords/HW300184B2' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
    "words": ["早稲田大学,ワセダダイガク,固有名詞"]
}'

レスポンス例

{
    "status": "000000",
    "message": "Success",
    "data": 2
}

単語の削除

基本情報

Path： /v1/hotwords/{hotwords_id}

Method： DELETE

APIの説明： 指定されたIDの単語辞書から、指定された単語を削除します。注意：リクエストにリクエストボディ（Body）がない場合、単語辞書全体が削除されます。

リクエストパラメータ

Body（json）

名前	タイプ	必須	説明	デフォルト値
words	list<string>	はい	削除予定の単語リスト	必須

レスポンスパラメータ

名前	タイプ	説明
status	string	ステータスコード
message	string	ステータスコードの説明
data	int	現在の辞書内の単語数

リクエスト例

curl --location --request DELETE 'https://api.voice.dolphin-ai.jp/v1/hotwords/HWCFCB0FF0' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{"words": ["早稲田大学,ワセダダイガク,固有名詞"]}'

レスポンス例

{
    "status": "000000",
    "message": "Success",
    "data": 4
}

単語辞書のダウンロード

基本情報

Path： /v1/hotwords/download/{hotwords_id}

Method： GET

APIの説明： 指定された単語辞書をダウンロードします。

リクエスト例

curl --location 'https://api.voice.dolphin-ai.jp/v1/hotwords/download/HWF8C024CA' \
--header 'Authorization: ••••••'

レスポンス例

Starting from the second line, enter one hot word per line. Note: For hot words in Japanese or mixed Japanese-English languages, you need to maintain 'writing, pronunciation, class' with three items separated by commas. If any item is missing, it is considered an invalid hot word. For hot words in other languages, only the 'writing' needs to be maintained.
インスパイア,コンニチハ,固有名詞
カタカナ,コンニチハ,固有名詞
プレゼント,コンニチハ,固有名詞

目次