リファレンス
COTOHA APIの各APIの入出力仕様についてご説明します。
構文解析
構文解析APIは、入力として日本語で記述された文を受け取り、文の構造と意味を解析・出力します。入力された文は、文節・形態素に分解され、文節間の係り受け関係や形態素間の係り受け関係、品詞情報などの意味情報などが付与されます。
リクエスト
HTTPエンドポイント
リクエストヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json;charset=UTF-8 |
Authorization |
Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | 説明 |
---|---|---|---|
sentence |
string |
必須 |
解析対象文 |
type |
string |
任意 |
以下のどちらかを指定可(省略時:default) default - 通常文 kuzure - SNSなどの崩れた文 |
dic_type |
array |
任意 |
使用する専門用語辞書を指定する。以下のタイプから複数指定可能。(for Enterpriseユーザのみ) IT - コンピュータ・情報・通信 automobile - 自動車 chemistry - 化学・石油工業 company - 企業 construction - 土木建築 economy - 経済・法令 energy - 電力・エネルギー institution - 機関・団体 machinery - 機械 medical - 医学 metal - 非鉄・金属 |
リクエストサンプル(cURL)
$ curl -X POST -H "Content-Type:application/json;charset=UTF-8" -H "Authorization:Bearer [Access Token]" -d '{"sentence":"犬は歩く。","type": "default"}' "[API Base URL]/nlp/v1/parse"
レスポンス
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
result |
array(object) |
|
status |
integer |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
構文解析結果レスポンスオブジェクト
キー名 | データ型 | 説明 |
---|---|---|
chunk_info |
object |
|
tokens |
array(object) |
文節情報オブジェクト
キー名 | データ型 | 説明 |
---|---|---|
id |
integer |
形態素番号(0オリジン) |
head |
integer |
係り先の文節番号 |
dep |
string |
係りタイプ O - 掛かり先なし Q - 自己掛かり A - 同格 I - 部分並列内関係 P - 並列関係 D - 通常の関係 |
chunk_head |
integer |
内容語の形態素開始位置(chunk内の0オリジン相対番号) |
chunk_func |
integer |
機能語の形態素開始位置(chunk内の0オリジン相対番号) |
links |
array(object) |
|
predicate |
array(string) |
機能語の付加情報の配列 negative - 否定 past - 過去時制 passive - 受動態 |
掛かり元情報の配列
キー名 | データ型 | 説明 |
---|---|---|
link |
integer |
掛かり元の文節番号 |
label |
string |
形態素情報オブジェクト
キー名 | データ型 | 説明 |
---|---|---|
id |
integer |
文節番号(0オリジン) |
form |
string |
表記 |
kana |
string |
カナ読み |
lemma |
string |
lemma |
pos |
string |
|
features |
array(string) |
|
dependency_labels |
array(object) |
|
attributes |
object |
付属情報 |
依存先情報の配列
キー名 | データ型 | 説明 |
---|---|---|
token_id |
integer |
依存先の形態素番号 |
label |
string |
レスポンスサンプル
{ "result" : [ { "chunk_info" : { "id" : 0, "head" : 1, "dep" : "D", "chunk_head" : 0, "chunk_func" : 1, "links" : [ ] }, "tokens" : [ { "id" : 0, "form" : "犬", "kana" : "イヌ", "lemma" : "犬", "pos" : "名詞", "features" : [ ], "dependency_labels" : [ { "token_id" : 1, "label" : "case" } ], "attributes" : { } }, { "id" : 1, "form" : "は", "kana" : "ハ", "lemma" : "は", "pos" : "連用助詞", "features" : [ ], "attributes" : { } } ] }, { "chunk_info" : { "id" : 1, "head" : -1, "dep" : "O", "chunk_head" : 0, "chunk_func" : 1, "links" : [ { "link" : 0, "label" : "agent" } ], "predicate" : [ ] }, "tokens" : [ { "id" : 2, "form" : "歩", "kana" : "アル", "lemma" : "歩く", "pos" : "動詞語幹", "features" : [ "K" ], "dependency_labels" : [ { "token_id" : 0, "label" : "nmod" }, { "token_id" : 3, "label" : "aux" }, { "token_id" : 4, "label" : "punct" } ], "attributes" : { } }, { "id" : 3, "form" : "く", "kana" : "ク", "lemma" : "く", "pos" : "動詞接尾辞", "features" : [ "終止" ], "attributes" : { } }, { "id" : 4, "form" : "。", "kana" : "", "lemma" : "。", "pos" : "句点", "features" : [ ], "attributes" : { } } ] } ], "status" : 0, "message" : "" }
入出力項目
品詞一覧
構文解析APIで出力される品詞の一覧について以下に示します。
品詞名 | 説明 | 例 |
---|---|---|
名詞 |
人物、場所などの具体的な対象をあらわす形態素。 |
- |
名詞接尾辞 |
名詞の後に接続する形態素。 |
「f組」の「組」、「可用性」の「性」 |
冠名詞 |
名詞の前に接続する形態素。 |
「大募集」の「大」 |
英語接尾辞 |
英語の名詞の後に接続する形態素。 |
「talking」の「ing」 |
動詞語幹 |
動詞の語幹部分をあらわす形態素。 |
「表す」の「表」、「見える」の「見え」 |
動詞活用語尾 |
動詞の活用をあらわす、動詞語幹の後に接続する形態素。 |
「示している」の「し」 |
動詞接尾辞 |
動詞語幹や動詞活用語尾などの後に接続する形態素。 |
「示している」の「て」 |
冠動詞 |
動詞語幹の前に接続する形態素。 |
「ぶち破る」の「ぶち」 |
補助名詞 |
連体の句の直後にあらわれる形態素。 |
「顔に出たため」の「ため」、「見なかったこと」の「こと」 |
形容詞語幹 |
形容詞の語幹部分をあらわす形態素。 |
「安い価格」の「安」 |
形容詞接尾辞 |
形容詞語幹などの後に接続する形態素。 |
「安い価格」の「い」 |
冠形容詞 |
形容詞語幹の前に接続する形態素。 |
「超面白い」の「超」 |
連体詞 |
単独で連体の文節を構成する形態素。 |
「同じ役割」の「同じ」 |
連用詞 |
一般的に副詞と呼ばれる、単独で連用の文節を構成する形態素。 |
「また同様に」の「また」 |
接続詞 |
主に文頭に用いられ、文と文などの関係をあらわす形態素。 |
「しかし」「また」「なお」 |
独立詞 |
感動詞とも呼ばれる、挨拶や呼びかけをあらわす形態素。 |
「さようなら」 |
接続接尾辞 |
動詞や形容詞の後に接続する形態素。 |
「~であるが」の「が」 |
判定詞 |
名詞の後に接続して述語の文節を構成する形態素。 |
「ニューデリーでは」の「では」 |
格助詞 |
名詞などの後に接続して、連用・連体の文節を構成する形態素。 |
「リンゴが赤い」の「が」 |
引用助詞 |
引用をあらわす形態素。 |
「~だと推測される」の「と」 |
連用助詞 |
副助詞とも呼ばれる形態素。 |
「現在も続く」の「も」 |
終助詞 |
終止の文節を構成する形態素。 |
「~ですよ」の「よ」 |
間投詞 |
文節の切れ目に置かれる形態素。 |
「私はね、~」の「ね」 |
括弧 |
括弧類の形態素。 |
- |
句点 |
句点及び疑問符、感嘆符の形態素。 |
- |
読点 |
読点の形態素。 |
- |
空白 |
空白文字の形態素。 |
- |
Symbol |
記号の形態素。 |
「♪」「+」など |
Number |
数値をあらわす形態素。 |
- |
助数詞 |
Numberの後に接続する形態素。 |
「約3杯」の「杯」 |
助助数詞 |
助数詞の後に接続する形態素。 |
「五個あたり」の「あたり」 |
冠数詞 |
Numberの前に接続する形態素。 |
「第3回目」の「第」 |
副品詞一覧
構文解析APIで出力される副品詞の一覧について以下に示します。副品詞は品詞ごとに分類されます。
品詞名 | 副品詞名 | 説明 | 例 |
---|---|---|---|
名詞 |
動作 |
サ変名詞 後ろに「する」を従えて動詞になることができる |
「学習」、「発展」 |
形容 |
形容動詞 |
「寛容」、「おてんば」 |
|
固有 |
固有名詞 |
「キリスト」 |
|
固有:姓 |
人の姓を表す固有名詞 |
「鈴木」 |
|
固有:名 |
人の名を表す固有名詞 |
「一郎」 |
|
固有:地 |
地名を表す固有名詞 |
「日本」、「北海道」 |
|
固有:組織 |
組織を表す固有名詞 |
「国土交通省」、「NTT」 |
|
代名詞 |
人称代名詞 |
「彼」、「あなた」 |
|
指示 |
指示代名詞 |
「それ」、「こちら」 |
|
日時 |
日時を表す名詞 |
「6月」、「去年」 |
|
時間 |
時刻を表す名詞 |
「23時」、「15分」 |
|
動詞語幹 |
A |
一段活用動詞 |
「食べる」の「食べ」 |
K |
カ行五段活用動詞 |
「書く」の「書」 |
|
G |
ガ行五段活用動詞 |
「泳ぐ」の「泳」 |
|
S |
サ行五段活用動詞 |
「話す」の「話」 |
|
T |
タ行五段活用動詞 |
「打つ」の「打」 |
|
N |
ナ行五段活用動詞 |
「死ぬ」の「死」 |
|
B |
バ行五段活用動詞 |
「飛ぶ」の「飛」 |
|
M |
マ行五段活用動詞 |
「積む」の「積」 |
|
R |
ラ行五段活用動詞 |
「変わる」の「変わ」 |
|
W |
ワ行五段活用動詞 |
「失う」の「失」 |
|
KURU |
カ行変格活用動詞:「来る」「くる」のみ |
「来る」の「来」 |
|
SURU |
サ行変格活用動詞:「する」のみ |
「する」の「す」 |
|
SX |
サ行変格活用動詞 |
「供する」の「供」 |
|
RX |
ラ行五段活用動詞(特殊):「いらっしゃる」「おっしゃる」「くださる」「ござる」「なさる」のみ |
「下さる」の「下さ」 |
|
IKU |
カ行五段活用動詞(特殊):「行く」「いく」のみ |
「行く」の「行」 |
|
ZX |
ザ行変格活用動詞 |
「信ずる」の「信」 |
|
Lて連用 |
補助動詞 |
「聞いてみる」の「み」 |
|
形容詞語幹 |
アウオ段 |
活用語尾直前の語がアウオ段になる形容詞 |
「暖かい」の「暖か」 |
イ段 |
活用語尾直前の語がイ段になる形容詞 |
「美しい」の「美し」 |
|
Lて連用 |
補助形容詞 |
「買ってほしい」の「ほし」 |
|
名詞接尾辞 |
名詞 |
名詞に接尾して名詞を作る |
「家族ぐるみ」の「ぐるみ」 |
動作 |
名詞に接尾して名詞を作り、「する」をつけることができる |
「日陰干しする」の「干し」 |
|
形容 |
名詞に接尾して名詞を作り、名詞の形容と同じ働きをする |
「野菜嫌い」の「嫌い」 |
|
動詞語幹 |
名詞に接尾して動詞を形成する |
「勇気づける」の「づけ」 |
|
形容詞語幹 |
名詞に接尾して形容詞を形成する |
「パリ近くで発見」の「近」 |
|
動詞接尾辞 |
命令 |
語尾変化が「命令形」 |
「よく、考えろ!」の「ろ」 |
名詞 |
動詞に接尾して、名詞を形成する |
「使いっぱなしはよくない」の「っぱなし」 |
|
動詞語幹 |
動詞に接尾して、動詞を形成する |
「両立させる」の「せ」 |
|
形容詞語幹 |
動詞に接尾して、形容詞を形成する |
「動きたくない」の「な」 |
|
形容詞接尾辞 |
名詞 |
形容詞に接尾して、名詞を形成する |
「かわいさ」の「さ」 |
動詞語幹 |
形容詞に接尾して、動詞を形成する |
「寒がる」の「が」 |
|
形容詞語幹 |
形容詞に接尾して、形容詞を形成する |
「美しかあない」の「かあな」 |
|
接続接尾辞 |
動詞語幹 |
接尾辞に接尾して動詞的に働く |
「行くに違いありません」の「に違いあ」 |
形容詞語幹 |
接尾辞に接尾して形容詞的に働く |
「取り込めるらしい」の「らし」 |
|
判定詞 |
名詞 |
名詞に接尾して名詞的に働く |
「本物かどうかを見極める」の「かどうか」 |
形容詞語幹 |
名詞に接尾して形容詞的に働く |
「大人っぽい」の「っぽい」 |
|
括弧 |
開括弧 |
"("や"{"など |
「]」 |
閉括弧 |
"("に対する")" |
「)」 |
|
句点 |
疑問符 |
? |
「?」 |
感嘆符 |
! |
「!」 |
意味役割ラベル一覧
構文解析APIで出力される意味役割ラベルの一覧について以下に示します。
意味ラベル名称 | 説明 | 例 |
---|---|---|
agent |
有意動作を引き起こす主体 |
|
agentnonvoluntary |
主体に意思性のないagent |
|
coagent |
agentと一緒に動作をする主体 |
|
aobject |
属性を持つ対象 |
|
object |
動作・変化の影響を受ける対象 |
|
implement |
有意思動作における道具・手段 |
|
source |
事象の主体または対象の最初の位置 |
をから |
material |
材料または構成要素 |
|
goal |
事象の主体または対象の最後の位置 |
|
beneficiary |
利益・不利益の移動先 |
|
place |
事象の成立する場所 |
|
scene |
事象の成立する場面 |
|
manner |
動作・変化のやり方 |
|
time |
事象の起こる時間 |
に |
timefrom |
事象の始まる時間 |
|
timeto |
事象の終わる時間 |
|
basis |
比較の基準 |
|
unit |
単位 |
|
fromto |
範囲 |
|
purpose |
目的 |
|
condition |
事象・事実の条件関係 |
|
adjectivals |
形容 |
|
adverbials |
形容(動作) |
- |
other |
その他 |
- |
依存関係ラベル一覧
構文解析APIで出力される依存関係ラベルの一覧について以下に示します。
universal dependencies v1に準拠しています。
依存関係ラベル名称 | 説明 | 例 |
---|---|---|
nsubj |
主格で述語に係る名詞句。 |
空気が美味い 美味い → nsubj 空気 |
nsubjpass |
主格で受身の助動詞を伴う用言に係る名詞句。 |
希望が託される 託さ → nsubjpass 希望 |
dobj |
目的格で述語に係る名詞句。 |
手を繋ぐ 繋ぐ → dobj 手 |
iobj |
格助詞「に」を伴うなどして述語に係る名詞句。 |
花子にあげる あげる → iobj 花子 |
nmod |
「が」「を」「に」以外の格の名詞句や、時相名詞により用言を修飾する場合。 |
ここで叫ぶ 叫ぶ → nmod ここ |
csubj |
主語になる名詞節。準体助詞を伴う用言句が主語となる場合。 |
笑うのが下手 下手 → csubj 笑う |
csubjpass |
準体助詞を伴う用言句が主語となる場合に、受身の助動詞を伴う用言を修飾する場合。 |
言ったのが悔やまれる。 悔やま → csubjpass 言っ |
ccomp |
補文。 |
甘えたいと思う 思う → ccomp 甘え |
advcl |
副詞節。主に接続助詞を伴って用言を修飾する節。 |
平凡だけどそこが良い 良い → advcl 平凡 |
advmod |
副詞による修飾。 |
絶対許さない 許さ → advmod 絶対 |
neg |
否定語の付与。 |
絶対許さない 許さ → neg ない |
nummod |
数量の指定。 |
3冊の本 冊 → nummod 3 |
appos |
同格の表現。 |
友達(♀) 友達 → appos ♀ |
acl |
連体修飾節。ただしamodに該当する場合を除く。また「てからの」「ながらの」等の接続表現。 |
愛を込めたプレゼント プレゼント → acl 込め |
amod |
形容詞・形状詞・連体詞(DET(この、その、あんな、どんな等)以外)が格を伴わずに名詞を修飾する場合。 |
偉大な力 力 → amod 偉大 |
det |
DET(この、その、あんな、どんな等)による修飾。 |
この本 本 → det この |
compound |
名詞と名詞・動詞と動詞の複合。 |
自覚症状 症状 → compound 自覚 |
name |
固有名詞の複合語。 |
山田太郎 山田 → name 太郎 |
conj |
並列構造。左側の要素を主辞とする。 |
アダムとイブ アダム → conj イブ |
cc |
等位接続詞。 |
アダムとイブ アダム → cc と |
aux |
用言につく助動詞や、非自立の補助用言。「か」などの終助詞を含む。 |
甘えたいと思う 甘え → aux たい |
auxpass |
受動態で動詞句を形成するために、動詞に接続する助動詞。「れる/られる」。 |
希望が託される 託さ → auxpass れる |
cop |
コピュラ。 |
太郎は学生だ。 学生 → cop だ |
case |
助詞による格の表示。 |
空気が美味い 空気 → case が |
mark |
従属接続詞、接続助詞、補文標識の「と」「か」等が付く場合。 |
笑うのが下手 笑う → mark の |
punct |
句読点。 |
食べます。 食べ → punct 。 |
vocative |
呼びかけ。 |
太郎君、走れ 走る → vocative 君 |
discourse |
談話要素。 |
あー疲れる 疲れる → discourse あー |
固有表現抽出
固有表現抽出APIは、入力として日本語で記述された文を受け取り、人名や地名、日付表現(時間、日付)、組織名、量的表現(金額、割合)、人工物の8種類の固有表現と、200種類以上のクラス数を持つ拡張固有表現を出力します。
リクエスト
HTTPエンドポイント
リクエストヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json;charset=UTF-8 |
Authorization |
Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | 説明 |
---|---|---|---|
sentence |
string |
必須 |
解析対象文 |
type |
string |
任意 |
以下のどちらかを指定可(省略時:default) default - 通常文 kuzure - SNSなどの崩れた文 |
dic_type |
array |
任意 |
使用する専門用語辞書を指定する。以下のタイプから複数指定可能。(for Enterpriseユーザのみ) IT - コンピュータ・情報・通信 automobile - 自動車 chemistry - 化学・石油工業 company - 企業 construction - 土木建築 economy - 経済・法令 energy - 電力・エネルギー institution - 機関・団体 machinery - 機械 medical - 医学 metal - 非鉄・金属 |
リクエストサンプル(cURL)
$ curl -X POST -H "Content-Type:application/json;charset=UTF-8" -H "Authorization:Bearer [Access Token]" -d '{"sentence":"昨日は東京駅を利用した。","type": "default"}' "[API Base URL]/nlp/v1/ne"
レスポンス
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
result |
array(object) |
|
status |
integer |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
固有表現抽出結果オブジェクト
レスポンスサンプル
{ "result" : [ { "begin_pos" : 0, "end_pos" : 2, "form" : "昨日", "std_form" : "昨日", "class" : "DAT", "extended_class" : "", "info" : { "normalized_datetime" : "2021-12-22" }, "source" : "basic" }, { "begin_pos" : 3, "end_pos" : 6, "form" : "東京駅", "std_form" : "東京駅", "class" : "LOC", "extended_class" : "", "source" : "basic" } ], "status" : 0, "message" : "" }
入出力項目
固有表現クラス一覧
固有表現抽出APIで出力される固有表現クラスの一覧について以下に示します。
名称 | 説明 |
---|---|
ORG |
組織名 |
PSN |
人名 |
LOC |
場所 |
ART |
固有物名 |
DAT |
日付表現 |
TIM |
時刻表現 |
NUM |
数値表現 |
MNY |
金額表現 |
PCT |
割合表現 |
OTH |
その他 |
拡張固有表現クラス一覧
固有表現抽出APIで出力される拡張固有表現クラスの一覧について以下に示します。
大項目 | 中項目 | 名称 | 説明 |
---|---|---|---|
名前 |
Name |
名前 |
|
Name_Other |
名前_その他 |
||
Person |
人名 |
||
God |
神名 |
||
組織名 |
Organization |
組織名 |
|
Organization_Other |
組織名_その他 |
||
International_Organization |
国際組織名 |
||
Show_Organization |
公演組織名 |
||
Family |
家系名 |
||
組織名 |
民族名 |
Ethnic_Group |
民族名 |
Ethnic_Group_Other |
民族名_その他 |
||
Nationality |
国籍名 |
||
競技組織名 |
Sports_Organization |
競技組織名 |
|
Sports_Organization_Other |
競技組織名_その他 |
||
Pro_Sports_Organization |
プロ競技組織名 |
||
Sports_League |
競技リーグ名 |
||
法人名 |
Corporation |
法人名 |
|
Corporation_Other |
法人名_その他 |
||
Company |
企業名 |
||
Company_Group |
企業グループ名 |
||
政治的組織名 |
Political_Organization |
政治的組織名 |
|
Political_Organization_Other |
政治的組織名_その他 |
||
Government |
政府組織名 |
||
Political_Party |
政党名 |
||
Cabinet |
内閣名 |
||
Military |
軍隊名 |
||
地名 |
Location |
地名 |
|
Location_Other |
地名_その他 |
||
Spa |
温泉名 |
||
地名 |
GPE(Geographical/Social/Political Entities: 政府を持つ地域名) |
GPE |
GPE(Geographical/Social/Political Entities: 政府を持つ地域名) |
GPE_Other |
GPE_その他 |
||
City |
市区町村名 |
||
County |
郡名 |
||
Province |
都道府県州名 |
||
Country |
国名 |
||
地域名 |
Region |
地域名 |
|
Region_Other |
地域名_その他 |
||
Continental_Region |
大陸地域名 |
||
Domestic_Region |
国内地域名 |
||
地形名 |
Geological_Region |
地形名 |
|
Geological_Region_Other |
地形名_その他 |
||
Mountain |
山地名 |
||
Island |
島名 |
||
River |
河川名 |
||
Lake |
湖沼名 |
||
Sea |
海洋名 |
||
Bay |
湾名 |
||
天体名 |
Astral_Body |
天体名 |
|
Astral_Body_Other |
天体名_その他 |
||
Star |
恒星名 |
||
Planet |
惑星名 |
||
Constellation |
星座名 |
||
アドレス |
Address |
アドレス |
|
Address_Other |
アドレス_その他 |
||
Postal_Address |
郵便住所 |
||
Phone_Number |
電話番号 |
||
|
電子メール |
||
URL |
URL |
||
施設名 |
Facility |
施設名 |
|
Facility_Other |
施設名_その他 |
||
Facility_Part |
施設部分名 |
||
施設名 |
遺跡名 |
Archaeological_Place |
遺跡名 |
Archaeological_Place_Other |
遺跡名_その他 |
||
Tumulus |
古墳名 |
||
GOE(geographical and organizational entity: 組織名の属性を持つ施設) |
GOE |
GOE |
|
GOE_Other |
GOE_その他 |
||
Public_Institution |
公共機関名 |
||
School |
学校名 |
||
Research_Institute |
研究機関名 |
||
Market |
取引所名 |
||
Park |
公園名 |
||
Sports_Facility |
競技施設名 |
||
Museum |
美術博物館名 |
||
Zoo |
動植物園名 |
||
Amusement_Park |
遊園施設名 |
||
Theater |
劇場名 |
||
Worship_Place |
神社寺名 |
||
Car_Stop |
停車場名 |
||
Station |
電車駅名 |
||
Airport |
空港名 |
||
Port |
港名 |
||
路線名 |
Line |
路線名 |
|
Line_Other |
路線名_その他 |
||
Railroad |
電車路線名 |
||
Road |
道路名 |
||
Canal |
運河名 |
||
Water_Route |
航路名 |
||
Tunnel |
トンネル名 |
||
Bridge |
橋名 |
||
製品名 |
Product |
製品名 |
|
Product_Other |
製品名_その他 |
||
Material |
材料名 |
||
Clothing |
衣類名 |
||
Money_Form |
貨幣名 |
||
Drug |
医薬品名 |
||
Weapon |
武器名 |
||
Stock |
株名 |
||
Award |
賞名 |
||
Decoration |
勲章名 |
||
Offense |
罪名 |
||
Service |
便名 |
||
Class |
等級名 |
||
Character |
キャラクター名 |
||
ID_Number |
識別番号 |
||
製品名 |
乗り物名 |
Vehicle |
乗り物名 |
Vehicle_Other |
乗り物名_その他 |
||
Car |
車名 |
||
Train |
列車名 |
||
Aircraft |
飛行機名 |
||
Spaceship |
宇宙船名 |
||
Ship |
船名 |
||
食べ物名 |
Food |
食べ物名 |
|
Food_Other |
食べ物名_その他 |
||
Dish |
料理名 |
||
芸術作品名 |
Art |
芸術作品名 |
|
Art_Other |
芸術作品名_その他 |
||
Picture |
絵画名 |
||
Broadcast_Program |
番組名 |
||
Movie |
映画名 |
||
Show |
公演名 |
||
Music |
音楽名 |
||
Book |
文学名 |
||
出版物名 |
Printing |
出版物名 |
|
Printing_Other |
出版物名_その他 |
||
Newspaper |
新聞名 |
||
Magazine |
雑誌名 |
||
主義方式名 |
Doctrine_Method |
主義方式名 |
|
Doctrine_Method_Other |
主義方式名_その他 |
||
Culture |
文化名 |
||
Religion |
宗教名 |
||
Academic |
学問名 |
||
Style |
流派名 |
||
Sport |
競技名 |
||
Movement |
運動名 |
||
Theory |
理論名 |
||
Plan |
政策計画名 |
||
規則名 |
Rule |
規則名 |
|
Rule_Other |
規則名_その他 |
||
Treaty |
条約名 |
||
Law |
法令名 |
||
称号名 |
Title |
称号名 |
|
Title_Other |
称号名_その他 |
||
Position_Vocation |
地位職業名 |
||
言語名 |
Language |
言語名 |
|
Language_Other |
言語名_その他 |
||
National_Language |
国語名 |
||
単位名 |
Unit |
単位名 |
|
Unit_Other |
単位名_その他 |
||
Currency |
通貨単位名 |
||
イベント名 |
Event |
イベント名 |
|
Event_Other |
イベント名_その他 |
||
イベント名 |
催し物名 |
Occasion |
催し物名 |
Occasion_Other |
催し物名_その他 |
||
Religious_Festival |
例祭名 |
||
Game |
競技会名 |
||
Conference |
会議名 |
||
事故事件名 |
Incident |
事故事件名 |
|
Incident_Other |
事故事件名_その他 |
||
War |
戦争名 |
||
自然現象名 |
Natural_Phenomenon |
自然災害名 |
|
Natural_Phenomenon_Other |
自然現象名_その他 |
||
Natural_Disaster |
自然災害名 |
||
Earthquake |
地震名 |
||
自然物名 |
Natural_Object |
自然物名 |
|
Natural_Object_Other |
自然物名_その他 |
||
Element |
元素名 |
||
Compound |
化合物名 |
||
Mineral |
鉱物名 |
||
自然物名 |
生物名 |
Living_Thing |
生物名 |
Living_Thing_Other |
生物名_その他 |
||
Fungus |
真菌類名 |
||
Mollusc_Arthropod |
軟体動物_節足動物名 |
||
Insect |
昆虫類名 |
||
Fish |
魚類名 |
||
Amphibia |
両生類名 |
||
Reptile |
爬虫類名 |
||
Bird |
鳥類名 |
||
Mammal |
哺乳類名 |
||
Flora |
植物名 |
||
生物部位名 |
Living_Thing_Part |
生物部位名 |
|
Living_Thing_Part_Other |
生物部位名_その他 |
||
Animal_Part |
動物部位名 |
||
Flora_Part |
植物部位名 |
||
病気名 |
Disease |
病気名 |
|
Disease_Other |
病気名_その他 |
||
Animal_Disease |
動物病気名 |
||
色名 |
Color |
色名 |
|
Color_Other |
色名_その他 |
||
Nature_Color |
自然色名 |
||
時間表現 |
Time_Top |
時間表現 |
|
Time_Top_Other |
時間表現_その他 |
||
時間表現 |
時間 |
Timex |
時間 |
Timex_Other |
時間_その他 |
||
Time |
時刻表現 |
||
Date |
日付表現 |
||
Day_Of_Week |
曜日表現 |
||
Era |
時代表現 |
||
期間 |
Periodx |
期間 |
|
Periodx_Other |
期間_その他 |
||
Period_Time |
時刻期間 |
||
Period_Day |
日数期間 |
||
Period_Week |
週数期間 |
||
Period_Month |
月数期間 |
||
Period_Year |
年数期間 |
||
数値表現 |
Numex |
数値表現 |
|
Numex_Other |
数値表現_その他 |
||
Money |
金額表現 |
||
Stock_Index |
株指標 |
||
Point |
ポイント |
||
Percent |
割合表現 |
||
Multiplication |
倍数表現 |
||
Frequency |
頻度表現 |
||
Age |
年齢 |
||
School_Age |
学齢 |
||
Ordinal_Number |
序数 |
||
Rank |
順位表現 |
||
Latitude_Longtitude |
緯度経度 |
||
数値表現 |
寸法表現 |
Measurement |
寸法表現 |
Measurement_Other |
寸法表現_その他 |
||
Physical_Extent |
長さ |
||
Space |
面積 |
||
Volume |
体積 |
||
Weight |
重量 |
||
Speed |
速度 |
||
Intensity |
密度 |
||
Temperature |
温度 |
||
Calorie |
カロリー |
||
Seismic_Intensity |
震度 |
||
Seismic_Magnitude |
マグニチュード |
||
個数 |
Countx |
個数 |
|
Countx_Other |
個数_その他 |
||
N_Person |
人数 |
||
N_Organization |
組織数 |
||
N_Location |
場所数 |
||
N_Location_Other |
場所数_その他 |
||
N_Country |
国数 |
||
N_Facility |
施設数 |
||
N_Product |
製品数 |
||
N_Event |
イベント数 |
||
N_Natural_Object |
自然物数 |
||
N_Natural_Object_Other |
自然物数_その他 |
||
N_Animal |
動物数 |
||
N_Flora |
植物数 |
付属情報(info)出力
固有表現抽出APIで出力される付属情報ついて以下に示します。
キー | 説明 |
---|---|
normalized_datetime |
正規化日時。固有表現クラスがDATかTIMEの固有表現について、具体的な日時が推測できる場合に出力されます。書式は、ISO 8601の拡張書式のうち、以下のパターンのいずれかとなります。タイムゾーンはJST固定です。
|
id |
専門用語辞書を指定した場合、辞書内のIDが出力されます。表記ゆれがあっても同一のIDとなるので、IDを手がかりに同一性の判定ができます。 |
固有名詞(企業名)補正
固有名詞(企業名)補正APIは、テキストから固有名詞(企業名)を抽出・補正します。
表現の誤りや揺れを含む企業名に対して補正された企業名情報を付与します。
入力文から補正された企業名を抽出することができるため、企業名を含む多数のテキストデータについて企業ごとの集計・解析に応用することが可能です。
なお、Developers環境アカウントでは、本APIをご利用いただけませんのでご了承ください。
リクエスト
HTTPエンドポイント
POST [API Base URL]/nlp/v1/normalize_ne/company
リクエストヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json;charset=UTF-8 |
Authorization |
Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | 説明 |
---|---|---|---|
sentence |
string |
必須 |
解析対象文 |
type |
string |
任意 |
以下のどちらかを指定可(省略時:default) default - 通常文 kuzure - SNSなどの崩れた文 |
リクエストサンプル(cURL)
$ curl -X POST -H "Content-Type:application/json;charset=UTF-8" -H "Authorization:Bearer [Access Token]" -d '{"sentence":"NTTに勤務しています","type": "default"}' "[API Base URL]/nlp/v1/normalize_ne/company"
レスポンス
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
result |
array(object) |
|
status |
integer |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
企業名補正結果オブジェクト
キー名 | データ型 | 説明 |
---|---|---|
begin_pos |
integer |
開始文字位置(0オリジン) |
end_pos |
integer |
終了文字位置(0オリジン) |
form |
string |
補正前表記 |
normalized |
array(object) |
補正後企業名情報オブジェクト
キー名 | データ型 | 説明 |
---|---|---|
form |
string |
補正後表記(通称) |
distance |
integer |
補正前表記と補正後表記(通称)との距離 |
std_forms |
array(string) |
企業名の正式名称の配列 |
レスポンスサンプル
{ "result": [ { "begin_pos": 0, "end_pos": 3, "form": "ntt", "normalized": [ { "distance": 0, "form": "ntt", "std_forms": ["日本電信電話株式会社", "東日本電信電話株式会社", "西日本電信電話株式会社"] }] }], "status": 0, "message": "" }
照応解析
照応解析APIは、入力として日本語で記述された複数の文からなるテキストを受け取り、テキスト中の「そこ」「それ」などの指示詞や「彼」「彼女」などの代名詞と対応する先行詞を抽出し、同一のものとしてまとめて出力します。
リクエスト
HTTPエンドポイント
POST [API Base URL]/nlp/v1/coreference
リクエストヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json;charset=UTF-8 |
Authorization |
Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | 説明 |
---|---|---|---|
document |
string / array(string) |
必須 |
以下のどちらかの形式で指定 string - 解析対象の文 array(string) - 解析対象の文集合 |
type |
string |
任意 |
以下のどちらかを指定可(省略時:default) default - 通常文 kuzure - SNSなどの崩れた文 |
do_segment |
boolean |
任意 |
文区切りを実施するか否かを指定(省略時:false) true - documentがstringの場合に文区切りを実施する false - 文区切りを実施しない ※documentがarray(string)の場合は本項の指定は無効 |
リクエストサンプル(cURL)
$ curl -X POST -H "Content-Type:application/json;charset=UTF-8" -H "Authorization:Bearer [Access Token]" -d '{"document":"太郎は友人です。彼は焼き肉を食べた。","type": "default","do_segment":true}' "[API Base URL]/nlp/v1/coreference"
レスポンス
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
result |
object |
|
status |
integer |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
照応解析結果オブジェクト
キー名 | データ型 | 説明 |
---|---|---|
coreference |
array(object) |
|
tokens |
array(string) |
解析対象文の各文を形態素解析して得られた表記の配列 |
照応解析情報オブジェクト
キー名 | データ型 | 説明 |
---|---|---|
representative_id |
integer |
照応解析情報ID(0オリジン) |
referents |
object |
エンティティオブジェクト
キー名 | データ型 | 説明 |
---|---|---|
referent_id |
integer |
エンティティのID(0オリジン) |
sentence_id |
integer |
エンティティが含まれる文の番号(0オリジン) |
token_id_from |
integer |
エンティティの開始形態素番号 |
token_id_to |
integer |
エンティティの終了形態素番号 |
レスポンスサンプル
{ "result" : { "coreference" : [ { "representative_id" : 0, "referents" : [ { "referent_id" : 0, "sentence_id" : 0, "token_id_from" : 0, "token_id_to" : 0, "form" : "太郎" }, { "referent_id" : 1, "sentence_id" : 1, "token_id_from" : 0, "token_id_to" : 0, "form" : "彼" } ] } ], "tokens" : [ [ "太郎", "は", "友人", "です" ], [ "彼", "は", "焼き肉", "を", "食べ", "た" ] ] }, "status" : 0, "message" : "OK" }
キーワード抽出
キーワード抽出APIは、入力として日本語で記述された複数の文からなるテキストを受け取り、テキストに含まれる特徴的なフレーズ・単語をキーワードとして抽出します。
テキストから算出される特徴的スコアに基づいて、複数のフレーズ・単語が降順に出力されます。
※丸括弧( )や角括弧 [ ]で括られたテキストは前処理で分析対象から取り除かれます。また、その結果入力文が空になった場合、HTTP 500エラーとなります。
リクエスト
HTTPエンドポイント
POST [API Base URL]/nlp/v1/keyword
リクエストヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json;charset=UTF-8 |
Authorization |
Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | 説明 |
---|---|---|---|
document |
string |
必須 |
以下のどちらかの形式で指定 string - 解析対象の文 array(string) - 解析対象の文集合 |
type |
string |
任意 |
以下のどちらかを指定可(省略時:default) default - 通常文 kuzure - SNSなどの崩れた文 |
do_segment |
boolean |
任意 |
文区切りを実施するか否かを指定(省略時:false) ・true - documentがstringの場合に文区切りを実施する ・false - 文区切りを実施しない ※documentがarray(string)の場合は本項の指定は無効 |
max_keyword_num |
integer |
任意 |
抽出するキーワードの上限個数(省略時:5) |
dic_type |
array |
任意 |
使用する専門用語辞書を指定する。以下のタイプから複数指定可能。(for Enterpriseユーザのみ) IT - コンピュータ・情報・通信 automobile - 自動車 chemistry - 化学・石油工業 company - 企業 construction - 土木建築 economy - 経済・法令 energy - 電力・エネルギー institution - 機関・団体 machinery - 機械 medical - 医学 metal - 非鉄・金属 |
リクエストサンプル(cURL)
$ curl -X POST -H "Content-Type:application/json;charset=UTF-8" -H "Authorization:Bearer [Access Token]" -d '{"document":"レストランで昼食を食べた。","type": "default","do_segment":true,"max_keyword_num":2}' "[API Base URL]/nlp/v1/keyword"
レスポンス
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
result |
array(object) |
|
status |
integer |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
抽出キーワードのオブジェクト
キー名 | データ型 | 説明 |
---|---|---|
form |
string |
キーワード |
score |
float |
キーワードのスコア |
レスポンスサンプル
{ "result" : [ { "form" : "レストラン", "score" : 14.144054 }, { "form" : "昼食", "score" : 12.1121 } ], "status" : 0, "message" : "" }
類似度算出
類似度算出APIは、入力として日本語で記述されたテキストを2つ受け取り、テキスト間の意味的な類似度を算出・出力します。
類似度は0から1の定義域で出力され、1に近づくほどテキスト間の類似性が大きいことを示します。
テキストに含まれる単語の意味情報を用いて類似度を算出しているため、異なった単語を含むテキスト間の類似性も推定することができます。
リクエスト
HTTPエンドポイント
POST [API Base URL]/nlp/v1/similarity
リクエストヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json;charset=UTF-8 |
Authorization |
Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | 説明 |
---|---|---|---|
s1 |
string |
必須 |
類似度算出対象のテキスト |
s2 |
string |
必須 |
類似度算出対象のテキスト |
type |
string |
任意 |
以下のどちらかを指定可(省略時:default) default - 通常文 kuzure - SNSなどの崩れた文 |
dic_type |
array |
任意 |
使用する専門用語辞書を指定する。以下のタイプから複数指定可能。(for Enterpriseユーザのみ) IT - コンピュータ・情報・通信 automobile - 自動車 chemistry - 化学・石油工業 company - 企業 construction - 土木建築 economy - 経済・法令 energy - 電力・エネルギー institution - 機関・団体 machinery - 機械 medical - 医学 metal - 非鉄・金属 |
リクエストサンプル(cURL)
$ curl -X POST -H "Content-Type:application/json;charset=UTF-8" -H "Authorization:Bearer [Access Token]" -d '{"s1":"近くのレストランはどこですか?","s2":"このあたりの定食屋はどこにありますか?", "type": "default"}' "[API Base URL]/nlp/v1/similarity"
レスポンス
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
result |
object |
|
status |
integer |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
類似度オブジェクト
キー名 | データ型 | 説明 |
---|---|---|
score |
float |
類似度(0.0~1.0) |
レスポンスサンプル
{ "result" : { "score" : 0.88565135 }, "status" : 0, "message" : "" }
文タイプ判定
文タイプ判定APIは、入力として日本語で記述された文を受け取り、文の法(叙述/疑問/命令)タイプと発話行為タイプを判定・出力します。
リクエスト
HTTPエンドポイント
POST [API Base URL]/nlp/v1/sentence_type
リクエストヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json;charset=UTF-8 |
Authorization |
Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | 説明 |
---|---|---|---|
sentence |
string |
必須 |
解析対象文 |
type |
string |
任意 |
以下のどちらかを指定可(省略時:default) default - 通常文 kuzure - SNSなどの崩れた文 |
リクエストサンプル(cURL)
$ curl -X POST -H "Content-Type:application/json;charset=UTF-8" -H "Authorization:Bearer [Access Token]" -d '{"sentence":"あなたの名前は何ですか?","type": "default"}' "[API Base URL]/nlp/v1/sentence_type"
レスポンス
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
result |
object |
|
status |
integer |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
文タイプオブジェクト
キー名 | データ型 | 説明 |
---|---|---|
modality |
string |
文種別。以下のいずれか。 declarative(叙述) interrogative(質問) imperative(命令) |
dialog_act |
array(string) |
発話行為種別の配列 |
レスポンスサンプル
{ "result" : { "modality" : "interrogative", "dialog_act" : [ "information-seeking" ] }, "status" : 0, "message" : "" }
入出力項目
発話行為種別一覧
文タイプ判定APIで出力される発話行為種別の一覧について以下に示します。
名称 | 説明 |
---|---|
greeting |
挨拶 |
information-providing |
情報提供 |
feedback |
フィードバック/相槌 |
information-seeking |
情報獲得 |
agreement |
同意 |
feedbackElicitation |
理解確認 |
commissive |
約束 |
acceptOffer |
受領 |
selfCorrection |
言い直し |
thanking |
感謝 |
apology |
謝罪 |
stalling |
時間埋め |
directive |
指示 |
goodbye |
挨拶(別れ) |
declineOffer |
否認 |
turnAssign |
ターン譲渡 |
pausing |
中断 |
acceptApology |
謝罪受領 |
acceptThanking |
感謝受領 |
感情分析
感情分析APIは、入力として日本語で記述されたテキストを受け取り、そのテキストの書き手の感情(ネガティブ・ポジティブ)を判定します。また、テキスト中に含まれる「喜ぶ」「驚く」「不安」「安心」といった15種類の感情を分類・認識して出力します。
リクエスト
HTTPエンドポイント
POST [API Base URL]/nlp/v1/sentiment
リクエストヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json;charset=UTF-8 |
Authorization |
Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | 説明 |
---|---|---|---|
sentence |
string |
必須 |
解析対象文 |
リクエストサンプル(cURL)
$ curl -X POST -H "Content-Type:application/json;charset=UTF-8" -H "Authorization:Bearer [Access Token]" -d '{"sentence":"人生の春を謳歌しています"}' "[API Base URL]/nlp/v1/sentiment"
レスポンス
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
result |
object |
|
status |
integer |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
感情分析結果オブジェクト
キー名 | データ型 | 説明 |
---|---|---|
sentiment |
string |
感情分析結果。Positive/Negative/Neutralのいずれかを出力する |
score |
float |
センチメントスコア |
emotional_phrase |
list |
感情フレーズオブジェクトの配列
キー名 | データ型 | 説明 |
---|---|---|
form |
string |
表記 |
emotion |
string |
レスポンスサンプル
{ "result": { "sentiment":"Positive", "score":0.20766788536018937, "emotional_phrase":[ { "form":"謳歌", "emotion":"喜ぶ,安心" } ] }, "status":0, "message":"OK" }
入出力項目
感情分析ラベル一覧
感情分析APIIで出力される感情分析ラベルの一覧について以下に示します。
感情分析ラベル |
---|
喜ぶ |
怒る |
悲しい |
不安 |
恥ずかしい |
好ましい |
嫌 |
興奮 |
安心 |
驚く |
切ない |
願望 |
P(Positive) |
N(Negative) |
PN(Positive かつ Negative) |
音声認識
なお、Developers環境アカウントでは、本APIをご利用いただけませんのでご了承ください。
音声認識APIは6つのAPIで構成されます。
1.ファイル音声認識
短時間の音声ファイルの音声をテキストに変換するAPIです。
2.ストリーミング音声認識
長時間の音声ファイルの音声やマイクからの入力などのストリーミング音声をテキストに変換するAPIです。
3.音声認識ユーザ辞書更新※
音声認識APIの語彙に含まれていない単語を登録するAPIです。
辞書は毎時0分時点のデータが反映されます。実際にデータが反映されるまでには、一定の時間を要します。
4.音声認識ユーザ辞書クリア※
登録された単語のクリアを行うAPIです。
辞書は毎時0分時点のデータが反映されます。実際にデータが反映されるまでには、一定の時間を要します。
5.音声認識ユーザ辞書適用状態取得※
辞書のデータが反映されているかを確認するAPIです。
6.音声認識ユーザ辞書ダウンロード※
最後にアップロードされた辞書をダウンロードするAPIです。
※これらのユーザ辞書を扱うAPIは、日本語モデルのみの提供となります。
こんな時はどうする?
・ファイルを音声認識させたい
音声長が60秒を超える場合は、ストリーミング音声認識をご利用下さい。
それ以下の場合は、ファイル音声認識をご利用下さい。
・リアルタイムに音声認識させたい
ストリーミング音声認識をご利用下さい。
・wavファイルを音声認識させたい
wavファイルの音声認識を行いたい場合、ヘッダの除去などを適切に行いLinear PCMもしくはμ-Lawフォーマットに変換を行なって下さい。
・辞書登録を行いたい
事前に単語を登録したい場合は、音声認識ユーザ辞書更新をご利用下さい。
音声認識シーケンスごとに単語を変えたい場合は、一時辞書をご利用下さい。
1.ファイル音声認識
ファイル音声認識では、短時間の音声ファイルの音声を認識してテキストに変換します。
対象は60秒以内の音声ファイルとなります。60秒を超える場合は、ストリーミング音声認識を利用してください。
リクエスト
HTTPエンドポイント
POST [API Base URL]/asr/v1/speech_recognition/[ASR Model ID]
ASR Model IDは音声認識に用いるモデルを識別するIDです。モデル一覧を参照して、適切なモデルを選択してください。
リクエストヘッダ
リクエストはマルチパートで記述します。マルチパートに用いる境界文字列を定めて、リクエストヘッダのboundaryで示してください。
キー名 | 説明 |
---|---|
Content-Type |
multipart/form-data; boundary=<境界文字列> |
Authorization |
Bearer [Access Token] |
リクエストボディ
マルチパートの各パートに設定するデータの内容および構造は、「パート種別」毎に規定します。「パート種別」は以下のものを使用します。なお、リクエスト内のパート種別は「Content-Disposition」のnameパラメータで設定します。
ボディのパートの順番は、必ず、パタメータパート、音声データパート、コマンドパートの順で設定してください。
パート種別 | 必須 | name | Content-Type |
---|---|---|---|
パラメータパート |
必須 |
parameter |
application/json; charset=UTF-8 |
音声データパート |
必須 |
audio |
application/octet-stream |
コマンドパート |
必須 |
command |
application/json; charset=UTF-8 |
パラメータパート
音声認識開始要求を行います。詳細はストリーミング音声認識 - 音声認識開始要求の項を参照してください。
音声データパート
音声データは下記のいずれかの形式に変換をして、バイナリを音声データパートとしてください。
※wavファイルの音声認識を行いたい場合、ヘッダの除去などを適切に行いLinear PCMもしくはμ-Lawフォーマットに変換を行なって下さい。
フォーマット | サンプリングレート[Hz] | 分解能[bit] | チャネル | バイト順 |
---|---|---|---|---|
Linear PCM |
モデルの帯域(8000または16000)以上※ |
16 |
モノラル |
リトルエンディアン |
μ-Law |
8000 |
8 |
モノラル |
リトルエンディアン |
※ ただし、8000, 11025, 16000, 22050, 32000, 44100, 48000, 88200, 96000[Hz]以外の音声に対しては、正常な動作を保証しません。
コマンドパート
音声認識停止要求を行います。詳細はストリーミング音声認識 - 音声認識停止要求の項を参照してください。
リクエストサンプル(HTTPヘッダ)
Content-Type: multipart/form-data; boundary=<境界文字列> Authorization: Bearer [Access Token]
リクエストサンプル(HTTPボディ)
--<境界文字列> Content-Disposition: form-data; name="parameter" Content-Type: application/json { "msg": { "msgname": "start" }, "param": { "baseParam.samplingRate": 16000, "recognizeParameter.domainId": "<ASR Domain ID>" } } --<境界文字列> Content-Disposition: form-data; name="audio" Content-Type: application/octet-stream <バイナリ音声データ> --<境界文字列> Content-Disposition: form-data; name="command" Content-Type: application/json { "msg": { "msgname": "stop" } } --<境界文字列>--
レスポンス
詳細は「ストリーミング音声認識 - レスポンス」の項を参照してください。
レスポンスサンプル
以下にレスポンスの例を示します。
[ { "msg" : { "msgname" : "started", "uniqueId" : "4d97031a-cfa9-4d66-968a-be708644a893" } }, { "msg" : { "msgname" : "speechStartDetected", "uniqueId" : "4d97031a-cfa9-4d66-968a-be708644a893" }, "timeinfo" : { "startDetectTime" : 0 } }, { "msg" : { "msgname" : "speechEndDetected", "uniqueId" : "4d97031a-cfa9-4d66-968a-be708644a893" }, "timeinfo" : { "endDetectTime" : 3460 } }, { "msg" : { "msgname" : "recognized", "uniqueId" : "4d97031a-cfa9-4d66-968a-be708644a893" }, "result" : { "type" : 1, "sentence" : [ { "surface" : "これ は テスト 用 の 音声ファイル です", "score" : 0.975848, "startTime" : 0.0, "endTime" : 3.46 } ] } }, { "msg" : { "msgname" : "recognized", "uniqueId" : "4d97031a-cfa9-4d66-968a-be708644a893" }, "result" : { "type" : 2, "sentence" : [ ] } }, { "msg" : { "msgname" : "completed", "uniqueId" : "4d97031a-cfa9-4d66-968a-be708644a893", "cause" : "STOP" } } ]
エラーコード
リクエストの内容を確認してください
以下のエラーが発生した場合は、記載された対処をした上でリクエストをやり直してください。エラーが解決しない場合、ご契約者様お問い合わせよりお問い合わせください。
code | message | detail | 説明および対処 |
---|---|---|---|
410 |
Invalid Parameter |
msg.msgname is invalid -> XXX. |
パラメータ不正。msgnameを確認してください。 |
410 |
Invalid Parameter |
param.baseParam.samplingRate is invalid -> XXX and over. |
パラメータ不正。サンプリングレートがモデルの帯域以上となっているか確認してください。 |
410 |
Invalid Parameter |
recognizeParameter.enableProgress must be false for file speech recognition. |
パラメータ不正。ファイル音声認識では逐次認識結果出力機能をご利用いただけません。 |
410 |
Invalid Parameter |
param.baseParam.samplingRate is invalid -> The sampling rate must be 8000 Hz. |
パラメータ不正。サンプリングレートが8000Hzとなっているか確認してください。 |
411 |
Invalid State |
Invalid Unique ID |
実行不能ステート。音声認識APIの呼び出し順番を確認してください。 |
413 |
Invalid Data |
Data is not available |
最大音声長の超過エラー。音声データ長が最大音声長を超える場合、複数回に分けて認識を行ってください。また、サンプリングレート、音声コーデック、モデルの指定が適切かご確認ください。 |
550 |
No Resource |
VRG_RESPONSE_SERVICE_UNAVAILABLE |
空きリソースが存在しません。ASR Domain IDが正しいかご確認ください。ASR Domain IDが正しい場合、APIへのアクセスが混雑している可能性がございます。しばらく時間を置いて、リクエストをやり直してください。 |
651 |
Session Timeout |
セッションタイムアウト。APIの呼び出し順番を確認してください。 |
|
652 |
Excess Of Max Voice Length |
Excess Of Max Voice Length -> 60 [s] |
最大音声長の超過エラー。音声データ長が最大音声長を超える場合、複数回に分けて認識を行ってください。また、サンプリングレート、音声コーデック、モデルの指定が適切かご確認ください。 |
一時辞書の内容を確認してください
以下のエラーが発生した場合は、記載された対処をした上でリクエストをやり直してください。エラーが解決しない場合、ご契約者様お問い合わせよりお問い合わせください。
code | message | detail | 対処 |
---|---|---|---|
410 |
Invalid Parameter |
Invalid Parameter -> List is null |
表記・読みを記述してください。 |
410 |
Invalid Parameter |
Cascade words exceeded 1000 |
一時辞書では、追加単語を1000行以下で指定してください。 |
410 |
Invalid Parameter |
Surface empty |
表記を記述してください。 |
410 |
Invalid Parameter |
Reading empty |
読みを記述してください。 |
410 |
Invalid Parameter |
Invalid domainid |
ASR Domain IDを確認してください。 |
410 |
Invalid Parameter |
Invalid Model Name |
ASR Model IDを確認してください。 |
410 |
Invalid Parameter |
Prob illegal |
重みは1~100の整数値で指定してください。 |
410 |
Invalid Parameter |
Surface illegal |
表記として設定可能な文字列か確認してください。 |
410 |
Invalid Parameter |
Reading illegal |
読みとして設定可能な文字列か確認してください。 |
410 |
Invalid Parameter |
Surface too long |
表記と読みの合計を251byte以下で指定してください。 |
お問い合わせください
以下のエラーが発生した場合は、ご契約者様お問い合わせよりお問い合わせください。
エラーコード | メッセージ |
---|---|
500 |
Internal Error |
510 |
Out Of Memory |
551 |
Recognition Timeout |
552 |
Network Error |
553 |
Network Timeout |
601 |
Recognition Converter Error |
610 |
Out Of Memory |
611 |
Invalid License |
612 |
Invalid Config |
650 |
No Resource |
690 |
External Command Execute Failed |
691 |
External Command Fatal |
692 |
External Command Error |
693 |
External Command Warn |
音声認識開始要求時のパラメータをご確認ください
音声認識開始要求時にパラメータ不正がある場合、HTTPステータスコード500で下記のレスポンスが返却される場合もあります。
{ "fault": { "faultstring": "NullPointerException", "detail": { "errorcode": "Internal Server Error" } } }
2.ストリーミング音声認識
ストリーミング音声認識では、マイクからの入力などのストリーミング音声や長時間の音声ファイルの音声を認識してテキストに変換します。音声の全体の長さは最長3,000秒です。3,000秒を超える音声は、3,000秒以下に分割して、それぞれストリーミング音声認識を実行してください。
リクエスト
要求の種類
ストリーミング音声認識では、以下の4種類の要求を利用します。
・音声認識開始要求
・音声認識データ送信
・音声認識停止要求
・音声認識キャンセル要求
標準的な要求の流れ(シーケンス)は以下の通りです。
1. 音声認識開始要求
2. 音声データ送信(複数回)
3. 音声認識停止要求
音声認識開始要求
音声認識クライアントから音声認識機能を利用する際に、音声認識クライアントが最初に音声認識APIサーバへ要求するリクエストです。本リクエストで音声認識のパラメータ設定が必要です。
HTTPエンドポイント
POST [API Base URL]/asr/v1/speech_recognition/[ASR Model ID]
ASR Model IDは音声認識に用いるモデルを識別するIDです。モデル一覧を参照して、適切なモデルを選択してください。
リクエストヘッダ
キー名 | 説明 |
---|---|
Connection |
Keep-Alive |
Content-Type |
application/json; charset=UTF-8 |
Authorization |
Bearer [Access Token] |
リクエストボディ
キー名 | 必須 | 説明 | 設定可能範囲 |
---|---|---|---|
msg |
|||
msgname |
必須 |
メッセージ種別 |
start |
param |
|||
baseParam.samplingRate |
必須 |
音声データのサンプリングレート |
pcmの場合はモデルの帯域(8000, 16000)以上の値※1、mulawの場合は8000 |
recognizeParameter.domainId |
必須 |
[ASR Domain ID] |
8桁の半角英数字 |
recognizeParameter.enableContinuous |
任意※2 |
連続認識機能有効設定 |
true(default: true) |
recognizeParameter.enableProgress |
任意 |
逐次認識結果出力有効設定※3 |
true, false(default: false) |
recognizeParameter.maxResults |
任意 |
認識結果最大数 |
1~30(default: 1) |
baseParam.audioCodec |
任意 |
音声コーデック |
pcm, mulaw(default: pcm) |
baseParam.filler |
任意 |
言い淀みの出力有無 |
true, false(default: false) |
baseParam.punctuation |
任意 |
句読点の出力有無 |
true, false(default: false) |
baseParam.reading |
任意 |
読み仮名の出力有無 |
true, false(default: false) |
baseParam.delimiter |
任意 |
区切り文字(半角スペース)の出力有無 |
true, false(default: true) |
words |
任意 |
一時辞書 |
1000語以下 |
※1 ただし、8000, 11025, 16000, 22050, 32000, 44100, 48000, 88200, 96000[Hz]以外の音声に対しては、正常な動作を保証しません。
※2 2020/3/23 までは連続認識機能有効設定は必須となっていましたが、任意のパラメータとなりました。
※3 ただし、本機能はファイル音声認識APIではご利用いただけません。
音声コーデック
Linear PCM(pcm)およびμ-Law(mulaw)の指定が可能です。ただし、μ-Law形式の音声認識は、帯域が8kHzのモデル(ja-gen_tf-08, ja-mdl1_nrw-08, ja-mdl2_nrw-08)のみでご利用いただけます。
wavファイルの音声認識を行いたい場合、ヘッダの除去などを適切に行いLinear PCMもしくはμ-Lawフォーマットに変換を行なって下さい。
言い淀みの出力有無
本パラメータをtrueに設定することで、言い淀み(「あー」「えー」といった発話)を[]付きの形で出力することが出来ます。
※日本語モデル(ja-gen_tf-16, ja-gen_sf-16, ja-gen_tf-08, ja-mdl1_nrw-08, ja-mdl2_nrw-08)でのみ有効です。
baseParam.filler=false(default)
これ は テスト 用 の 音声ファイル です
baseParam.filler=true
[えーと] これ は テスト 用 の 音声ファイル です
句読点の出力有無
本パラメータをtrueに設定することで、句読点を含む形で音声認識結果が出力されます。
※ja-gen_tf-16, ja-gen_tf-08, ja-mdl1_nrw-08, ja-mdl2_nrw-08モデルでのみ有効です。
※文末に句点がつく保証はございません。
baseParam.punctuation=false(default)
こんにちは よろしくお願いします
baseParam.punctuation=true
こんにちは 。 よろしくお願いします
読み仮名の出力有無
本パラメータをtrueに設定することで、認識結果を漢字仮名交じり文だけではなく、カタカナでも取得可能です。
※日本語モデル(ja-gen_tf-16, ja-gen_sf-16, ja-gen_tf-08, ja-mdl1_nrw-08, ja-mdl2_nrw-08)でのみ有効です。
'reading': 'コレ ワ テスト ヨウ ノ オンセイファイル デス'
readingを含む出力フォーマットについてはレスポンスサンプルも参照してください。
区切り文字(半角スペース)の出力有無
本パラメータをfalseに設定することで、通常の認識結果で単語間に挿入される半角スペースを除去することが可能です。
※英語モデル(en_en-gen_sf-16)ご利用時は、trueを推奨します。
baseParam.delimiter=true(default)
これ は テスト 用 の 音声ファイル です
baseParam.delimiter=false
これはテスト用の音声ファイルです
逐次認識結果出力有効設定
本パラメータをtrueに設定することで、終話に至っていない発話の認識途中結果を逐次的に取得することが可能です。
認識途中結果は認識結果タイプtype=0として、返却されます。
なお、認識途中結果に対しては、各出力有無パラメータの指定に関わらず、一律で読み仮名の出⼒はされず、言い淀み・句読点・区切り⽂字は出⼒されます。
認識結果最大数
recognizeParameter.maxResultsとして指定された数を上限として、音声認識結果を複数返却します。ただし、指定した数は上限値であり、必ずその数だけ返却されることは保証されていません。
recognizeParameter.maxResultsを2以上とした場合の出力フォーマットについてはレスポンスサンプルを参照してください。
一時辞書
音声認識シーケンスごとに設定可能な一時的な辞書です。
音声認識ユーザ辞書更新と併用してご利用いただけます。
一時辞書はシーケンスが終了すると破棄され、ユーザ辞書の更新は行われません。
キー名 | 説明 | 値の範囲 | 必須 |
---|---|---|---|
surface |
表記※1 |
|, /, :, ;, [, ], \t, \"を含まない、かつ空文字ではない文字列 |
必須 |
reading |
読み※1 |
全角カタカナ |
必須 |
prob |
単語の重み※2 |
1~100の整数値(default: 30) |
任意 |
※1 表記と読みの合計を251byte以下で指定してください。
※2 登録単語の出現確率を調整したい場合にご利用ください。
30より大きい値を設定することで、通常の辞書登録よりも高めの効果で辞書登録が可能です。
また、30より小さい値を設定することで、通常の辞書登録よりも低めの効果で辞書登録が可能です。
リクエストサンプル
HTTPヘッダ
Connection: Keep-Alive Content-Type: application/json; charset=UTF-8 Authorization: Bearer <Access Token>
HTTPボディ
{ "msg": { "msgname": "start" }, "param": { "baseParam.samplingRate": 16000, "recognizeParameter.domainId": "<ASR Domain ID>", "baseParam.audioCodec": "pcm", "baseParam.filler": true, "baseParam.reading": true, "baseParam.delimiter": false, "baseParam.punctuation": true, "recognizeParameter.enableProgress": true, "recognizeParameter.maxResults": 2 }, "words": [ { "surface": "エヌ・ティ・ティ・コミュニケーションズ株式会社", "reading": "エヌティティコミュニケーションズカブシキガイシャ", "prob": "20" }, { "surface": "COTOHA", "reading": "コトハ", "prob": "40" } ] }
音声認識データ送信
音声認識を行うデータを音声認識APIサーバへ送信するリクエストです。リクエストを送ってから次のリクエストを送るまでの間隔を240ミリ秒[ms]※としてください。音声認識データ送信のレスポンスを待ち、エラーがないことを確認して次のデータを送信してください。なお、最初の音声認識データ送信は音声認識開始要求のレスポンスを受けてから1秒以内※に行なってください。
※通信環境等の問題で、所定の時間内に次のリクエストを送信できない場合は、レスポンスを受信次第、次のリクエストを送信して下さい。
HTTPエンドポイント
POST [API Base URL]/asr/v1/speech_recognition/[ASR Model ID]
リクエストヘッダ
キー名 | 説明 |
---|---|
Connection |
Keep-Alive |
Content-Type |
application/octet-stream |
Unique-Id |
音声認識開始要求のレスポンスヘッダで返されたUniqueID |
Authorization |
Bearer [Access Token] |
Cookie |
- token(リクエストの順番を識別するためのユニークな文字列。直近のレスポンスで受け取ったtokenを設定します。) |
リクエストボディ
音声データは下記のいずれかの形式に変換をして、バイナリをリクエストボディとしてください。
※wavファイルの音声認識を行いたい場合、ヘッダの除去などを適切に行いLinear PCMもしくはμ-Lawフォーマットに変換を行なって下さい。
フォーマット | サンプリングレート[Hz] | 分解能[bit] | チャネル | バイト順 | 音声データ長[ms] |
---|---|---|---|---|---|
Linear PCM |
モデルの帯域(8000または16000)以上※1 |
16 |
モノラル |
リトルエンディアン |
240※2 |
μ-Law |
8000 |
8 |
モノラル |
リトルエンディアン |
240※2 |
すなわち、1回のリクエストボディのサイズは、Linear PCMフォーマットの場合は8kHzのモデルの場合は3840バイト、16kHzのモデルの場合は7680バイト、μ-Lawフォーマットの場合は1720バイトとなります。
※1 ただし、8000, 11025, 16000, 22050, 32000, 44100, 48000, 88200, 96000[Hz]以外の音声に対しては、正常な動作を保証しません。
※2 ただし、音声認識データ送信の最後のリクエストに限り、240ミリ秒[ms]未満のデータも可
リクエストサンプル
HTTPヘッダ
Connection: Keep-Alive Content-Type: application/octet-stream Authorization: Bearer <Access Token> Cookie: GCLB=<音声認識開始要求のレスポンスで受け取ったGCLBを設定>;token=<直近のレスポンスで受け取ったtoken>
HTTPボディ
<バイナリ音声データ>
音声認識停止要求
音声認識クライアントから音声認識処理の停止要求するリクエストです。音声認識APIサーバは全ての音声認識が完了したのち、200(OK)を返します。なお、音声認識停止要求は音声認識データ送信の最後のレスポンスを受けてから、1秒以内に行なってください。
HTTPエンドポイント
POST [API Base URL]/asr/v1/speech_recognition/[ASR Model ID]
リクエストヘッダ
キー名 | 説明 |
---|---|
Connection |
Keep-Alive |
Content-Type |
application/json; charset=UTF-8 |
Unique-Id |
音声認識開始要求のレスポンスヘッダで返されたUniqueID |
Authorization |
Bearer [Access Token] |
Cookie |
- token(リクエストの順番を識別するためのユニークな文字列。直近のレスポンスで受け取ったtokenを設定します。) |
リクエストボディ
キー名 | 説明 | 設定可能範囲 |
---|---|---|
msg |
||
msgname |
メッセージ種別 |
stop |
リクエストサンプル
HTTPヘッダ
Connection: Keep-Alive Content-Type: application/json; charset=UTF-8 Authorization: Bearer <Access Token> Cookie: GCLB=<音声認識開始要求のレスポンスで受け取ったGCLBを設定>;token=<直近のレスポンスで受け取ったtoken>
HTTPボディ
{ "msg": { "msgname": "stop" } }
音声認識キャンセル要求
音声認識クライアントから音声認識処理のキャンセルを要求するリクエストです。キャンセルでは送信済み音声データの認識処理は行わず、200(OK)を返します。なお、音声認識キャンセル要求は音声認識データ送信の最後のレスポンスを受けてから、1秒以内に行なってください。
HTTPエンドポイント
POST [API Base URL]/asr/v1/speech_recognition/[ASR Model ID]
リクエストヘッダ
キー名 | 説明 |
---|---|
Connection |
Keep-Alive |
Content-Type |
application/json; charset=UTF-8 |
Unique-Id |
音声認識開始要求のレスポンスヘッダで返されたUniqueID |
Authorization |
Bearer [Access Token] |
Cookie |
- token(リクエストの順番を識別するためのユニークな文字列。直近のレスポンスで受け取ったtokenを設定します。) |
リクエストボディ
キー名 | 説明 | 設定可能範囲 |
---|---|---|
msg |
||
msgname |
メッセージ種別 |
cancel |
リクエストサンプル
HTTPヘッダ
Connection: Keep-Alive Content-Type: application/json; charset=UTF-8 Authorization: Bearer <Access Token> Cookie: GCLB=<音声認識開始要求のレスポンスで受け取ったGCLBを設定>;token=<直近のレスポンスで受け取ったtoken>
HTTPボディ
{ "msg": { "msgname": "cancel" } }
レスポンス
HTTPリクエストに対して、以下のサーバ応答の組み合わせからなるHTTPレスポンスが返却されます。サーバ応答が1個以上含まれる場合はHTTPステータスコード200(OK)でHTTPボディ部にJSONが含まれるHTTPレスポンスが返却されます。サーバ応答が0個の場合、HTTPステータスコード204(No Content)が返却されます。
サーバ応答の種類 | msgname | 備考 |
---|---|---|
started |
音声認識開始リクエストの応答 |
|
speechStartDetected |
音声データの発話開始を検出後のリクエストの応答 |
|
speechEndDetected |
音声データの発話終了を検出後のリクエストの応答 |
|
recognized |
音声認識結果 |
|
completed |
音声認識が終了、または音声認識処理中にエラーが発生 |
全てのサーバ応答に「msgname」と「uniqueId」が含まれます。「msgname」はサーバ応答の種類を表し、「uniqueId」は音声認識ごとにユニークな識別子です。
音声認識準備完了応答
音声認識開始要求に対して、音声認識APIサーバから音声認識クライアントに準備の完了を通知するメッセージです。
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json; charset=UTF-8 |
Set-Cookie |
- token(リクエストの順番を識別するためのユニークな文字列) |
レスポンスボディ
キー名 | 説明 | 備考 |
---|---|---|
msg |
||
msgname |
メッセージ種別 |
started |
uniqueId |
音声認識毎にユニークな識別子 |
音声認識データ送信や音声認識停止要求・音声認識キャンセル要求に必要なパラメータ |
レスポンスサンプル
[ { "msg": { "msgname": "started", "uniqueId": "3bfbe5de-eee7-4824-a661-3750d8cb9328" } } ]
発話検出応答
転送された音声データから発話を検出した際に返されるメッセージです。
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json; charset=UTF-8 |
Set-Cookie |
token(リクエストの順番を識別するためのユニークな文字列) |
レスポンスボディ
キー名 | 説明 | 備考 |
---|---|---|
msg |
||
msgname |
メッセージ種別 |
speechStartDetected |
uniqueId |
音声認識毎にユニークな識別子 |
音声認識APIサーバが付与した識別子 |
timeinfo |
||
startDetectTime |
発話検出時間[ms] |
音声データの先頭から発話検出までの時間 |
レスポンスサンプル
[ { "msg" : { "msgname" : "speechStartDetected", "uniqueId" : "3bfbe5de-eee7-4824-a661-3750d8cb9328" }, "timeinfo" : { "startDetectTime" : 0 } } ]
終話検出応答
転送された音声データで終話(発話の終了)を検出した際に返されるメッセージです。
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json; charset=UTF-8 |
Set-Cookie |
token(リクエストの順番を識別するためのユニークな文字列) |
レスポンスボディ
キー名 | 説明 | 備考 |
---|---|---|
msg |
||
msgname |
メッセージ種別 |
speechEndDetected |
uniqueId |
音声認識毎にユニークな識別子 |
音声認識APIサーバが付与した識別子 |
timeinfo |
||
endDetectTime |
発話検出時間[ms] |
音声データの先頭から終話検出までの時間 |
レスポンスサンプル
[ { "msg" : { "msgname" : "speechEndDetected", "uniqueId" : "4b96875f-2137-48ed-8b49-1e20483a7c86" }, "timeinfo" : { "endDetectTime" : 3200 } } ]
音声認識結果応答
音声認識の結果を音声認識APIサーバから音声認識クライアントに送信するためのメッセージです。
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json; charset=UTF-8 |
Set-Cookie |
token(リクエストの順番を識別するためのユニークな文字列) |
レスポンスボディ
キー名 | 説明 | 備考 |
---|---|---|
msg |
||
msgname |
メッセージ種別 |
recognized |
uniqueId |
音声認識毎にユニークな識別子 |
音声認識APIサーバが付与した識別子 |
result |
||
type |
認識結果タイプ |
0:認識途中結果 |
sentence |
||
surface |
音声認識結果テキスト |
|
score |
スコア |
0~1。数字が大きいほど確からしさが高い |
startTime |
文の開始時刻[秒] |
音声データの先頭からの時間 |
endTime |
文の終了時刻[秒] |
音声データの先頭からの時間 |
reading |
認識結果の読み |
baseParam.reading=trueの時のみ |
レスポンスサンプル
音声認識開始要球時のパラメータ
baseParam.filler: false(デフォルト値) baseParam.reading: false(デフォルト値) baseParam.delimiter: true(デフォルト値) baseParam.punctuation: false(デフォルト値) recognizeParameter.maxResults: 1(デフォルト値)
レスポンス
{ "msg": { "msgname": "recognized", "uniqueId": "49bbc297-6a8a-4354-9679-2866cc27385a" }, "result": { "type": 1, "sentence": [ { "surface": "これ は テスト 用 の 音声ファイル です", "score": 0.851436, "startTime": 0, "endTime": 2.99 } ] } }
レスポンスサンプル
言い淀みの出力あり、読み仮名の出力あり、区切り文字の出力なし、句読点の出力あり、認識結果最大数2
音声認識開始要球時のパラメータ
baseParam.filler: true baseParam.reading: true baseParam.delimiter: false baseParam.punctuation: true recognizeParameter.maxResults: 2
レスポンス
{ "msg": { "msgname": "recognized", "uniqueId": "a6342b20-6b0d-41b4-9c71-86af4f123369" }, "result": { "type": 1, "sentence": [ { "surface": "[えーと]、これはテスト用の音声ファイルです", "score": 0.851436, "startTime": 0, "endTime": 2.99, "reading": "エット、コレワテストヨウノオンセイファイルデス" }, { "surface": "[えーと]。これはテスト用の音声ファイルです", "score": 0.532213, "startTime": 0, "endTime": 2.99, "reading": "エット。コレワテストヨウノオンセイファイルデス" } ] } }
音声認識終了応答
音声認識処理の終了を音声認識APIサーバから音声認識クライアント宛に送信するメッセージです。音声認識処理中にエラーが発生した場合も本メッセージが返されます。
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json; charset=UTF-8 |
Set-Cookie |
token(リクエストの順番を識別するためのユニークな文字列) |
レスポンスボディ
キー名 | 説明 | 備考 |
---|---|---|
msg |
||
msgname |
メッセージ種別 |
completed |
uniqueId |
音声認識毎にユニークな識別子 |
音声認識APIサーバが付与した識別子 |
cause |
停止要因 |
以下のいずれか |
errorinfo |
||
code |
エラーコード |
|
message |
エラーメッセージ |
|
level |
エラーレベル |
以下のいずれか |
detail |
エラー詳細情報 |
※通常は発生しない停止要因です。発生時は、音声認識開始要求時にrecognizeParameter.enableContinuousが適切に設定されているかご確認ください。
レスポンスサンプル
[ { "msg" : { "msgname" : "completed", "uniqueId" : "4b96875f-2137-48ed-8b49-1e20483a7c86", "cause" : "STOP" } } ]
エラーコード
リクエストの内容を確認してください
以下のエラーが発生した場合は、記載された対処をした上でリクエストをやり直してください。なお、ストリーム音声認識APIにおけるエラーの場合は、音声認識のシーケンスの最初、音声認識開始要求からやり直していただきます。その際、音声認識停止要求や音声認識キャンセル要求のリクエストをする必要はありません。エラーが解決しない場合、ご契約者様お問い合わせよりお問い合わせください。
code | message | detail | 説明および対処 |
---|---|---|---|
410 |
Invalid Parameter |
msg.msgname is invalid -> XXX. |
パラメータ不正。msgnameを確認してください。 |
410 |
Invalid Parameter |
param.baseParam.samplingRate is invalid -> XXX and over. |
パラメータ不正。サンプリングレートがモデルの帯域以上となっているか確認してください。 |
410 |
Invalid Parameter |
param.baseParam.samplingRate is invalid -> The sampling rate must be 8000 Hz. |
パラメータ不正。サンプリングレートが8000Hzとなっているか確認してください。 |
411 |
Invalid State |
Invalid Unique ID |
実行不能ステート。音声認識APIの呼び出し順番を確認してください。 |
412 |
Interval Too Brief |
音声データの送信間隔が短すぎます。音声データの送信間隔を正しくしてください。 |
|
450 |
Invalid Token |
token Error |
(Access Tokenではなく)Cookieのtokenが不正です。リクエストはレスポンス受信を待ってから行ってください。 |
550 |
No Resource |
VRG_RESPONSE_SERVICE_UNAVAILABLE |
空きリソースが存在しません。ASR Domain IDが正しいかご確認ください。ASR Domain IDが正しい場合、APIへのアクセスが混雑している可能性がございます。しばらく時間を置いて、リクエストをやり直してください。 |
552 |
Network Error |
Network |
レスポンスを受けてから所定の時間内にリクエストを行なっているかを確認してください。 |
600 |
Internal Error |
レスポンスを受けてから所定の時間内にリクエストを行なっているかを確認してください。 |
|
651 |
Session Timeout |
セッションタイムアウト。APIの呼び出し順番、呼び出し間隔を確認してください。 |
一時辞書の内容を確認してください
以下のエラーが発生した場合は、記載された対処をした上でリクエストをやり直してください。なお、ストリーム音声認識APIにおけるエラーの場合は、音声認識のシーケンスの最初、音声認識開始要求からやり直していただきます。その際、音声認識停止要求や音声認識キャンセル要求のリクエストをする必要はありません。エラーが解決しない場合、ご契約者様お問い合わせよりお問い合わせください。
code | message | detail | 対処 |
---|---|---|---|
410 |
Invalid Parameter |
Invalid Parameter -> List is null |
表記・読みを記述してください。 |
410 |
Invalid Parameter |
Cascade words exceeded 1000 |
一時辞書では、追加単語を1000行以下で指定してください。 |
410 |
Invalid Parameter |
Surface empty |
表記を記述してください。 |
410 |
Invalid Parameter |
Reading empty |
読みを記述してください。 |
410 |
Invalid Parameter |
Invalid domainid |
ASR Domain IDを確認してください。 |
410 |
Invalid Parameter |
Invalid Model Name |
ASR Model IDを確認してください。 |
410 |
Invalid Parameter |
Prob illegal |
重みは1~100の整数値で指定してください。 |
410 |
Invalid Parameter |
Surface illegal |
表記として設定可能な文字列か確認してください。 |
410 |
Invalid Parameter |
Reading illegal |
読みとして設定可能な文字列か確認してください。 |
410 |
Invalid Parameter |
Surface too long |
表記と読みの合計を251byte以下で指定してください。 |
お問い合わせください
以下のエラーが発生した場合は、ご契約者様お問い合わせよりお問い合わせください。
エラーコード | メッセージ |
---|---|
500 |
Internal Error |
510 |
Out Of Memory |
551 |
Recognition Timeout |
553 |
Network Timeout |
601 |
Recognition Converter Error |
610 |
Out Of Memory |
611 |
Invalid License |
612 |
Invalid Config |
650 |
No Resource |
690 |
External Command Execute Failed |
691 |
External Command Fatal |
692 |
External Command Error |
693 |
External Command Warn |
3.音声認識ユーザ辞書更新
※日本語モデルのみ
音声認識クライアントからユーザ辞書更新のリクエストを要求します。ユーザ辞書は音声認識に利用するモデル毎に登録が必要です。日本語の音声認識モデルに対してのみユーザ辞書を登録することが可能です。ユーザ辞書更新により、すでに登録済みのユーザ辞書の内容は上書きされますのでご注意ください。
リクエスト
HTTPエンドポイント
POST [API Base URL]/asr/v1/speech_words/[ASR Model ID]/upload?domainid=[ASR Domain ID]
リクエストヘッダ
リクエストはマルチパートで記述します。マルチパートに用いる境界文字列を定めて、リクエストヘッダのboundaryで示してください。
キー名 | 説明 |
---|---|
Content-Type |
multipart/form-data; boundary=<境界文字列> |
Authorization |
Bearer [Access Token] |
リクエストボディ
リクエストボディに後述の「ユーザ辞書リスト」を記載します。
パート種別 | 必須 | name | Content-Type |
---|---|---|---|
ユーザ辞書リスト |
必須 |
cascadeword |
text/plain; charset=UTF-8 |
音声認識ユーザ辞書リスト
リストの各行に「単語の表記」「水平タブ(HT:0x09)」「単語の読み」を記載してください。
<HYOKI><HT><YOMI> <HYOKI><HT><YOMI> ... <HYOKI><HT><YOMI>
単語の重み※1を指定する場合は下記のように記載してください。単語ごとに、重みの指定を行うことができます。
<HYOKI><HT><YOMI><HT><PROB> <HYOKI><HT><YOMI> ... <HYOKI><HT><YOMI><HT><PROB>
項目 | 説明 | 値の範囲 | 必須 |
---|---|---|---|
HYOKI |
表記※2 |
|, /, :, ;, [, ], , "を含まない、かつ空文字ではない文字列 |
必須 |
YOMI |
読み※2 |
全角カタカナ |
必須 |
PROB |
単語の重み※1 |
1~100の整数値(default: 30) |
任意 |
※1 登録単語の出現確率を調整したい場合にご利用ください。
※2 表記と読みの合計を251byte以下で指定してください。
30より大きい値を設定することで、通常の辞書登録よりも高めの効果で辞書登録が可能です。
また、30より小さい値を設定することで、通常の辞書登録よりも低めの効果で辞書登録が可能です。
ユーザ辞書リストサンプル
エヌ・ティ・ティ・コミュニケーションズ株式会社 エヌティティコミュニケーションズカブシキガイシャ COTOHA コトハ 20
リクエストサンプル
HTTPヘッダ
Content-Type: multipart/form-data; boundary=<境界文字列> Authorization: Bearer <Access Token>
HTTPボディ
--<境界文字列> Content-Disposition: form-data; name="cascadeword"; filename="sample.tsv" Content-Type: text/plain エヌ・ティ・ティ・コミュニケーションズ株式会社 エヌティティコミュニケーションズカブシキガイシャ COTOHA コトハ 20 --<境界文字列>--
cURL
curl -H "Authorization:Bearer <Access Token>" -X POST -F cascadeword=@<音声認識ユーザ辞書リストを記載したtsvファイル>; [API Base URL]/asr/v1/speech_words/[ASR Model ID]/upload?domainid=[ASR Domain ID]
レスポンス
指定した「表記」、指定した「読み」、「M」(固定)、「単語の重み」が返ります。
「M」はサーバが自動的に付与するものですので、通常は気にする必要はありません。また、「単語の重み」を指定しなかった場合は、デフォルト値である30が返却されます。
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
multipart/form-data; boundary=<境界文字列> |
レスポンスサンプル
以下にレスポンスの例を示します。
--<境界文字列> Content-Type: text/plain Content-Disposition: form-data; name="status" code : 200 message : OK detail : success --<境界文字列> Content-Type: text/plain Content-Disposition: form-data; name="cascadeword" エヌ・ティ・ティコミュニケーションズ株式会社 エヌティティコミュニケーションズカブシキガイシャ M 30 COTOHA コトハ M 20 --<境界文字列>--
エラーコード
リクエストの内容を確認してください
以下のエラーが発生した場合は、記載された対処をした上でリクエストをやり直してください。エラーが解決しない場合、ご契約者様お問い合わせよりお問い合わせください。
code | message | detail | 説明および対処 |
---|---|---|---|
410 |
Invalid Parameter |
Invalid Parameter -> List is null |
表記・読みを記述してください。 |
410 |
Invalid Parameter |
Invalid Parameter -> List Exceed 5000 lines |
ユーザ辞書更新では、追加単語を5000行以下で指定してください。 |
410 |
Invalid Parameter |
Surface empty |
表記を記述してください。 |
410 |
Invalid Parameter |
Reading empty |
読みを記述してください。 |
410 |
Invalid Parameter |
Invalid domainid |
ASR Domain IDを確認してください。 |
410 |
Invalid Parameter |
Invalid Model Name |
ASR Model IDを確認してください。 |
410 |
Invalid Parameter |
Prob illegal |
重みは1~100の整数値で指定してください。 |
410 |
Invalid Parameter |
Surface illegal |
表記として設定可能な文字列か確認してください。 |
410 |
Invalid Parameter |
Reading illegal |
読みとして設定可能な文字列か確認してください。 |
410 |
Invalid Parameter |
Surface too long |
表記と読みの合計を251byte以下で指定してください。 |
お問い合わせください
以下のエラーが発生した場合は、ご契約者様お問い合わせよりお問い合わせください。
code | message | detail |
---|---|---|
410 |
Invalid Parameter |
Upload Error |
410 |
Invalid Parameter |
Download Error |
600 |
Internal Error |
- |
4.音声認識ユーザ辞書クリア
※日本語モデルのみ
音声認識クライアントからユーザ辞書のクリアのリクエストを要求します。ユーザ辞書は音声認識に利用するモデル毎にクリアが必要です。日本語の音声認識モデルに対してのみユーザ辞書をクリアすることが可能です。
リクエスト
HTTPエンドポイント
GET [API Base URL]/asr/v1/speech_words/[ASR Model ID]/clear?domainid=[ASR Domain ID]
リクエストヘッダ
キー名 | 説明 |
---|---|
Authorization |
Bearer [Access Token] |
リクエストサンプル
以下にリクエストのサンプルを示します。
HTTPヘッダ
Authorization: Bearer <Access Token>
cURL
curl -H "Authorization:Bearer <Access Token>" [API Base URL]/asr/v1/speech_words/[ASR Model ID]/clear?domainid=[ASR Domain ID]
レスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
multipart/form-data; boundary=<境界文字列> |
レスポンスサンプル
以下にレスポンスの例を示します。
--<境界文字列> Content-Type: text/plain Content-Disposition: form-data; name="status" code : 200 message : OK detail : success --<境界文字列>--
エラーコード
リクエストの内容を確認してください
以下のエラーが発生した場合は、記載された対処をした上でリクエストをやり直してください。エラーが解決しない場合、ご契約者様お問い合わせよりお問い合わせください。
code | message | detail | 説明および対処 |
---|---|---|---|
410 |
Invalid Parameter |
Invalid domainid |
ASR Domain IDを確認してください。 |
410 |
Invalid Parameter |
Invalid Model Name |
ASR Model IDを確認してください。 |
お問い合わせください
以下のエラーが発生した場合は、ご契約者様お問い合わせよりお問い合わせください。
code | message | detail |
---|---|---|
410 |
Invalid Parameter |
Upload Error |
410 |
Invalid Parameter |
Download Error |
600 |
Internal Error |
- |
5.音声認識ユーザ辞書適用状態取得
※日本語モデルのみ
音声認識クライアントからユーザ辞書適用状態取得のリクエストを要求します。各モデルごとに、ユーザ辞書更新が完了したかどうかを取得することが可能です。
リクエスト
HTTPエンドポイント
GET [API Base URL]/asr/v1/speech_words/[ASR Model ID]/isset?domainid=[ASR Domain ID]
リクエストサンプル
以下にリクエストのサンプルを示します。
HTTPヘッダ
Authorization: Bearer <Access Token>
cURL
curl -H "Authorization:Bearer <Access Token>" [API Base URL]/asr/v1/speech_words/[ASR Model ID]/isset?domainid=[ASR Domain ID]
レスポンス
ユーザ辞書更新が完了している場合はtrue、未完了の場合はfalseが返却されます。
エラー発生の有無によって、レスポンスのContent-Typeが異なりますので、ご注意ください。
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json |
レスポンスボディ
キー名 | 範囲 |
---|---|
isSet |
true, false |
レスポンスサンプル
以下にレスポンスの例を示します。
{ "isSet" : true }
エラー時のレスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
multipart/form-data; boundary=<境界文字列> |
レスポンスサンプル
以下にレスポンスの例を示します。
--<境界文字列> Content-Type: text/plain Content-Disposition: form-data; name="status" code : 410 message : Invalid Parameter detail : Invalid domainid --<境界文字列>--
エラーコード
リクエストの内容を確認してください
以下のエラーが発生した場合は、記載された対処をした上でリクエストをやり直してください。エラーが解決しない場合、ご契約者様お問い合わせよりお問い合わせください。
code | message | detail | 説明および対処 |
---|---|---|---|
410 |
Invalid Parameter |
Invalid domainid |
ASR Domain IDを確認してください。 |
410 |
Invalid Parameter |
Invalid Model Name |
ASR Model IDを確認してください。 |
お問い合わせください
以下のエラーが発生した場合は、ご契約者様お問い合わせよりお問い合わせください。
code | message | detail |
---|---|---|
410 |
Invalid Parameter |
Upload Error |
410 |
Invalid Parameter |
Download Error |
600 |
Internal Error |
- |
6.音声認識ユーザ辞書ダウンロード
※日本語モデルのみ
音声認識クライアントからユーザ辞書のダウンロードのリクエストを要求します。各モデルごとに、最後にアップロードされた辞書をダウンロードすることが可能です。
リクエスト
HTTPエンドポイント
GET [API Base URL]/asr/v1/speech_words/[ASR Model ID]/download?domainid=[ASR Domain ID]
リクエストヘッダ
キー名 | 説明 |
---|---|
Authorization |
Bearer [Access Token] |
リクエストサンプル
以下にリクエストのサンプルを示します。
HTTPヘッダ
Authorization: Bearer <Access Token>
cURL
curl -H "Authorization:Bearer <Access Token>" [API Base URL]/asr/v1/speech_words/[ASR Model ID]/download?domainid=[ASR Domain ID]
レスポンス
最後にアップロードされた辞書内の単語が返却されます。各行には表記、読み、単語の重みが記載されています。
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
multipart/form-data; boundary=<境界文字列> |
レスポンスサンプル
以下にレスポンスの例を示します。
-- Content-Type: text/plain Content-Disposition: form-data; name="status" code : 200 message : OK detail : success -- Content-Type: text/plain Content-Disposition: form-data; name="cascadeword" エヌ・ティ・ティコミュニケーションズ株式会社 エヌティティコミュニケーションズカブシキガイシャ 30 COTOHA コトハ 30 ----
エラーコード
リクエストの内容を確認してください
以下のエラーが発生した場合は、記載された対処をした上でリクエストをやり直してください。エラーが解決しない場合、ご契約者様お問い合わせよりお問い合わせください。
code | message | detail | 説明および対処 |
---|---|---|---|
410 |
Invalid Parameter |
Invalid domainid |
ASR Domain IDを確認してください。 |
410 |
Invalid Parameter |
Invalid Model Name |
ASR Model IDを確認してください。 |
お問い合わせください
以下のエラーが発生した場合は、ご契約者様お問い合わせよりお問い合わせください。
code | message | detail |
---|---|---|
410 |
Invalid Parameter |
Upload Error |
410 |
Invalid Parameter |
Download Error |
600 |
Internal Error |
- |
入出力項目
モデル一覧
モデル名 | ASR Model ID |
---|---|
日本語汎用Talk&Free(16kHz) |
ja-gen_tf-16 |
日本語汎用Short&Formal(16kHz) |
ja-gen_sf-16 |
日本語汎用Talk&Free(8kHz) |
ja-gen_tf-08 |
日本語通信業界向け(8kHz) |
ja-mdl1_nrw-08 |
日本語保険業界向け(8kHz) |
ja-mdl2_nrw-08 |
英語汎用_ネイティブShort&Formal(16kHz) |
en_en-gen_sf-16 |
・「Talk&Free」と「Short&Formal」に関して
・Talk&Free:人間同士の自然な発話、言いよどみや言い間違いが頻出する音声認識に適したモデルです。(会議、雑談、コールセンタ、顧客対応など)
・Short&Formal:事前にある程度話す内容を考えておくことができ、比較的明瞭に発話される単発の発話クエリ音声認識に適したモデルです。(検索クエリ、一問一答型システムとの対話など)
・「8kHz」と「16kHz」に関して
・8kHz:電話回線を通しての音声に対してのご利用を推奨しております。
・16kHz:それ以外の音声に対してのご利用を推奨しております。
音声合成
音声合成APIは以下の11のAPIで構成されます。
なお、Developers環境アカウントでは、本APIをご利用いただけませんのでご了承ください。
1.一括音声合成
テキストを合成音声に変換するAPIです。合成された音声は一度の通信で返却されます。
2.逐次音声合成
テキストを合成音声に変換するAPIです。合成された音声はチャンクに分割されて返却されます。
3.読み解析
テキストを読みテキストに変換するAPIです。(日本語のみ)
一括音声合成及び逐次音声合成ではこの読みテキストを入力として使用することもできます。
※読みテキストについては、入出力項目の読みテキストをご覧ください。
4.単語辞書登録
単語の読み方を定義したレコードを単語辞書に登録するAPIです。デフォルトでうまく読み上げない単語を正しく読み上げさせることができます。(日本語のみ)
5.単語辞書一覧取得
単語辞書に登録されているレコードの一覧を取得するAPIです。(日本語のみ)
6.単語辞書更新
単語辞書に登録されているレコードの更新を行うAPIです。(日本語のみ)
7.単語辞書削除
単語辞書に登録されているレコードの削除を行うAPIです。(日本語のみ)
8.文辞書登録
文章の読み方を定義したレコードを文辞書に登録するAPIです。デフォルトでうまく読み上げない文章を正しく読み上げさせることができます。読み上げ方は読みテキストで定義します。(日本語のみ)
9.文辞書一覧取得
文辞書に登録されているレコードの一覧を取得するAPIです。(日本語のみ)
10.文辞書更新
文辞書に登録されているレコードの更新を行うAPIです。(日本語のみ)
11.文辞書削除
文辞書に登録されているレコードの削除を行うAPIです。(日本語のみ)
入出力項目(データ仕様)
APIを使用する際の、一部パラメータの詳細項目や仕様の一覧です。
こんな時はどうする?
・合成音声を生成したい
1.一括音声合成API、2.逐次音声合成APIで合成音声を生成することができます。
・長い合成音声を生成する際のレスポンスが遅い
2.逐次音声合成APIを利用すると、音声が出来上がった部分から返却されるため、ストリーミング再生を行うことで、疑似的にレスポンスを早めることができます。
・どのように読み上げてくれるのかを知りたい
3. 読み解析APIで、テキストを読みテキストに変換することで、読み上げる内容を可視化することができます。
・音声を思ったように読み上げてくれない
4. 単語辞書登録API、8.文辞書APIを利用して正しい読み方を定義したレコードを登録することができます。
例えば、「なんでやねん」を読み上げさせる場合、デフォルトでは「な」にアクセントがあります。しかし、関西弁に近い形で読み上げさせたい場合は「で」にアクセントを付与する必要があります。この場合の設定内容としては、以下のようになります。
・単語辞書登録APIの単語の読みの場合
ナ'ンデヤネン → ナンデ'ヤネン
・文辞書登録APIの読みテキストの場合
ナンデヤネン[.01] → ナンデヤネン[.03]
・辞書登録したはずなのに思ったように読み上げてくれない、何が辞書登録されているのか知りたい。
5.単語辞書一覧取得API、9.文辞書一覧取得APIで登録内容をご確認ください。
・辞書登録したレコードを修正したい/削除したい
6.単語辞書更新API、10.文辞書更新APIでレコードの修正を行えます。
また、7.単語辞書削除API、11.文辞書削除APIでレコードの削除を行えます。
・話者や品詞として指定できる値を知りたい/読みテキストの詳細を知りたい
入出力項目(データ仕様)で、一部パラメータの詳細項目や仕様を確認できます。
1.一括音声合成
一括音声合成では、テキストを合成音声に変換します。合成された音声は一度の通信で返却されます。 長いテキストを合成する場合で、即時的なレスポンスが必要となる場合は逐次音声合成をご利用ください。
リクエスト
HTTPエンドポイント
POST [API Base URL]/tts/v1/tts
リクエストヘッダ
キー名 | 必須 | 説明 |
---|---|---|
Content-Type |
必須 |
application/json; charset=UTF-8 |
Authorization |
必須 |
アクセストークン |
Accept |
任意 |
以下の2つのどちらかを指定します。 audio/wav:Wave形式の音声データ text/plain:Base64エンコードされた音声データ ※省略時はaudio/wavが指定されたものとみなされます。 |
リクエストボディ
必須列が「任意」となっているパラメータが省略された場合、デフォルト値に書かれている内容が設定されたとみなされます。
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
text |
string |
必須 |
- |
音声合成対象テキスト 音声合成対象のテキストを指定します。 【制限】 テキスト種別(textType)毎に最大文字数が異なります。 - プレーンテキスト:500[文字] - 読みテキスト:1200[文字] ※プレーンテキストの最大文字数を超過しなくても、プレーンテキストに辞書を適用した結果の読みテキストが1200文字を超過した場合は、最大文字数超過となります。 テキスト種別(textType)毎に定められたフォーマットにて記述する必要があります。テキスト種別毎のフォーマットは、入出力項目の音声合成対象テキストを参照してください。 |
textType |
string |
任意 |
normal |
テキスト種別 音声合成対象テキストのテキスト種別を指定します。 - normal:プレーンテキスト - utterance:読みテキスト 【制限】 utteranceはspeakerIdに日本語話者を指定した場合のみ指定可能です。 |
speakerId |
string |
必須 |
- |
話者ID 音声合成を行う話者モデルのIDを指定します。 【制限】 指定できる話者IDは、入出力項目の話者ID一覧を参照してください。 |
speechRate |
number(fraction) |
任意 |
1 |
合成音声の話速 - 値が小さい:遅い - 値が大きい:速い 【制限】 - 値域:0.50~2.00 - 刻み幅:0.01 |
powerRate |
number(fraction) |
任意 |
1 |
合成音声の音量 - 値が小さい:小さい - 値が大きい:大きい 【制限】 - 値域:0.00~5.00 - 刻み幅:0.01 |
intonation |
number(interger) |
任意 |
10 |
合成音声の抑揚の大きさ - 値が小さい:小さい - 値が大きい:大きい 【制限】 - 値域:1~20 - 刻み幅:1 |
pitch |
number(interger) |
任意 |
12 |
合成音声の声の高さ - 値が小さい:低い - 値が大きい:高い 【制限】 - 値域:1~20 - 刻み幅:1 |
リクエストサンプル(cURL)
・必須パラメータのみ
curl -o result.wav -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Bearer [access token]" -d '{"text": "今日は晴れです。", "speakerId": "ja_JP-M-S0001-T001-E01-SR0"}' [API Base URL]/tts/v1/tts
・全てのパラメータを指定
curl -o result.wav -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Accept: text/plain" -H "Authorization: Bearer [access token]" -d '{"text": "キョーワ[,01]ハレデス^[.02]", "textType": "utterance", "speakerId": " ja_JP-M-S0001-T001-E01-SR0", "speechRate": "1.25", "powerRate": "2.0", "intonation": 5, "pitch": 15 }' [API Base URL]/tts/v1/tts
レスポンス
返却される音声データのサンプリングレートは22,050Hzとなります。
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ Acceptヘッダの値に応じて以下の値となります。 - audio/wav:audio/wav - text/plain:text/plain |
レスポンスボディ
データ型 | 説明 |
---|---|
binaryまたはstring |
音声データ Acceptヘッダの値に応じて以下の内容で返却します。 - audio/wav:Wave形式の音声バイナリ - text/plain:Base64エンコードされたテキスト |
レスポンスサンプル
音声データ(バイナリorテキスト)
エラー時のレスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
code |
string |
エラーコード 問い合わせの際に利用します。 |
detail |
string |
エラー詳細 エラー内容についての情報です。詳細はエラー時のdetailの一覧と対処を参照してください。 |
HTTPステータスコード
レスポンスコード | 説明及び対処 |
---|---|
400 Bad Request |
入力パラメータに不正があります。 レスポンスボディのdetailキーの内容と、こちらを参考に、正しいパラメータの指定を行ってください。 ※入力パラメータの不正には以下の例が挙げられます。 - パラメータの設定値が値域外の場合。 - 全角文字のみが使用できるパラメータで半角文字を使用している場合。 - パラメータに存在しないものを指定している場合。 |
401 Unauthorized |
アクセストークンに不正(期限切れ等)があります。 有効なアクセストークンを指定してください。 |
404 Not Found |
リクエストしたリソースが見つかりません。 URL及びHTTPメソッドを確認してください。 |
406 Not Acceptable |
Acceptヘッダの指定内容に不正があります。 Acceptヘッダの指定内容を確認してください。 |
413 Request Entity Too Large |
リクエストデータ全体のサイズが上限値を超過したため、処理を拒否しました。 リクエストデータを確認してください。 |
415 Unsupported Media Type |
リクエストに対応できないContent-Typeが指定されています。 Content-Typeヘッダの指定内容を確認してください。 |
500 internal Server Error |
サーバ内部でエラーが発生しました。 リクエストの内容を確認してください。その上で解決しない場合は、ご契約者様問い合わせよりお問い合わせください。 |
2.逐次音声合成
逐次音声合成では、テキストを合成音声に変換します。合成された音声はいくつかのチャンクに分けられて返却されます。 音声合成が完了したものから順にレスポンスが返ってくるため、ストリーミング再生を行いたい場合に便利です。
リクエスト
HTTPエンドポイント
POST [API Base URL]/tts/v1/sequential_tts
リクエストヘッダ
キー名 | 必須 | 説明 |
---|---|---|
Content-Type |
必須 |
送信データのMIMEタイプ application/json; charset=UTF-8 |
Authorization |
必須 |
アクセストークン 以下のフォーマットで指定 Bearer [Access Token] |
Accept |
任意 |
要求する受信データのMIMEタイプ 以下の2つのどちらかを指定します。 - audio/L16:16bitリニアPCM Raw形式のモノラル音声データ - text/plain:Base64エンコードされた音声データ ※省略時はaudio/L16が指定されたものとみなされます。 |
Connection |
必須 |
TCPコネクションの接続維持指定 Keep-Alive |
リクエストボディ
必須列が「任意」となっているパラメータが省略された場合、デフォルト値に書かれている内容が設定されたとみなされます。
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
text |
string |
必須 |
- |
音声合成対象テキスト 音声合成対象のテキストを指定します。 【制限】 テキスト種別(textType)毎に最大文字数が異なります。 - プレーンテキスト:500[文字] - 読みテキスト:1200[文字] ※プレーンテキストの最大文字数を超過しなくても、プレーンテキストに辞書を適用した結果の読みテキストが1200文字を超過した場合は、最大文字数超過となります。 テキスト種別(textType)毎に定められたフォーマットにて記述する必要があります。テキスト種別毎のフォーマットは、入出力項目の音声合成対象テキストを参照してください。 |
textType |
string |
任意 |
normal |
テキスト種別 音声合成対象テキストのテキスト種別を指定します。 - normal:プレーンテキスト - utterance:読みテキスト 【制限】 utteranceはspeakerIdに日本語話者を指定した場合のみ指定可能です。 |
speakerId |
string |
必須 |
- |
話者ID 音声合成を行う話者モデルのIDを指定します。 【制限】 指定できる話者IDは、入出力項目の話者ID一覧を参照してください。 |
speechRate |
number(fraction) |
任意 |
1.00 |
合成音声の話速 - 値が小さい:遅い - 値が大きい:速い 【制限】 - 値域:0.50~2.00 - 刻み幅:0.01 |
powerRate |
number(fraction) |
任意 |
1.00 |
合成音声の音量 - 値が小さい:小さい - 値が大きい:大きい 【制限】 - 値域:0.00~5.00 - 刻み幅:0.01 |
intonation |
number(interger) |
任意 |
10 |
合成音声の抑揚の大きさ - 値が小さい:小さい - 値が大きい:大きい 【制限】 - 値域:1~20 - 刻み幅:1 |
pitch |
number(interger) |
任意 |
12 |
合成音声の声の高さ - 値が小さい:低い - 値が大きい:高い 【制限】 - 値域:1~20 - 刻み幅:1 |
リクエストサンプル(cURL)
・必須パラメータのみ
curl -o result.raw -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Bearer [access token]" -d '{"text": "今日は晴れです。", "speakerId": "ja_JP-M-S0001-T001-E01-SR0"}' [API Base URL]/tts/v1/sequential_tts
・全てのパラメータを指定
curl -o result.wav -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Accept: text/plain" -H "Authorization: Bearer [access token]" -d '{"text": "キョーワ[,01]ハレデス^[.02]", "textType": "utterance", "speakerId": " ja_JP-M-S0001-T001-E01-SR0", "speechRate": "1.25", "powerRate": "2.0", "intonation": 5, "pitch": 15 }' [API Base URL]/tts/v1/sequential_tts
レスポンス
返却される音声データのサンプリングレートは22,050Hzとなります。
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ Acceptヘッダの値に応じて以下の値となります。 - audio/L16:audio/L16 - text/plain:text/plain |
Transfer-Encoding |
転送に使用されるエンコード形式 chunked |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
- |
number(interger) |
音声データサイズ 音声データのバイト数 |
- |
binaryまたはstring |
音声データ Acceptヘッダの値に応じて以下の内容で返却します。 - audio/L16:16bitリニアPCM Raw形式のモノラル音声バイナリ - text/plain:Base64エンコードされたテキスト |
レスポンスサンプル
チャンク1の音声データサイズ チャンク1音声データ(バイナリorテキスト) チャンク2の音声データサイズ チャンク2の音声データ(バイナリorテキスト) ・・・ チャンクNの音声データサイズ チャンクNの音声データ(バイナリorテキスト) 0
エラー時のレスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
code |
string |
エラーコード 問い合わせの際に利用します。 |
detail |
string |
エラー詳細 エラー内容についての情報です。詳細はエラー時のdetailの一覧と対処を参照してください。 |
HTTPステータスコード
レスポンスコード | 説明及び対処 |
---|---|
400 Bad Request |
入力パラメータに不正があります。 レスポンスボディのdetailキーの内容と、こちらを参考に、正しいパラメータの指定を行ってください。 ※入力パラメータの不正には以下の例が挙げられます。 - パラメータの設定値が値域外の場合。 - 全角文字のみが使用できるパラメータで半角文字を使用している場合。 - パラメータに存在しないものを指定している場合。 |
401 Unauthorized |
アクセストークンに不正(期限切れ等)があります。 有効なアクセストークンを指定してください。 |
404 Not Found |
リクエストしたリソースが見つかりません。 URL及びHTTPメソッドを確認してください。 |
406 Not Acceptable |
Acceptヘッダの指定内容に不正があります。 Acceptヘッダの指定内容を確認してください。 |
413 Request Entity Too Large |
リクエストデータ全体のサイズが上限値を超過したため、処理を拒否しました。 リクエストデータを確認してください。 |
415 Unsupported Media Type |
リクエストに対応できないContent-Typeが指定されています。 Content-Typeヘッダの指定内容を確認してください。 |
500 internal Server Error |
サーバ内部でエラーが発生しました。 リクエストの内容を確認してください。その上で解決しない場合は、ご契約者様問い合わせよりお問い合わせください。 |
3.読み解析
テキストを読みテキストに変換します。(日本語のみ)
1.一括音声合成及び2.逐次音声合成ではこの読みテキストを入力として使用することもできます。
※読みテキストについては、入出力項目の読みテキストをご覧ください。
リクエスト
HTTPエンドポイント
POST [API Base URL]/tts/v1/text_analyze
リクエストヘッダ
キー名 | 必須 | 説明 |
---|---|---|
Content-Type |
必須 |
送信データのMIMEタイプ application/json; charset=UTF-8 |
Authorization |
必須 |
アクセストークン 以下のフォーマットで指定 Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
text |
string |
必須 |
- |
読み解析対象テキスト 読み解析対象のプレーンテキストを指定します。 【制限】 最大文字数:500[文字] |
lang |
string |
必須 |
- |
言語種別 読み解析対象の言語種別を指定します。 - ja_JP:日本語 【制限】 ja_JPのみ指定可能です。 |
リクエストサンプル(cURL)
curl -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Bearer [access token]" -d '{"text": "今日は晴れです。", "lang": " ja_JP"}' [API Base URL]/tts/v1/text_analyze
レスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ text/plain |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
- |
string |
読みテキスト 読みテキストについては、入出力項目の読みテキストの項目を参照してください。 |
レスポンスサンプル
キョーワ[,01]ハレデス^[.02]
エラー時のレスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
code |
string |
エラーコード 問い合わせの際に利用します。 |
detail |
string |
エラー詳細 エラー内容についての情報です。詳細はエラー時のdetailの一覧と対処を参照してください。 |
HTTPステータスコード
レスポンスコード | 説明及び対処 |
---|---|
400 Bad Request |
入力パラメータに不正があります。 レスポンスボディのdetailキーの内容と、こちらを参考に、正しいパラメータの指定を行ってください。 ※入力パラメータの不正には以下の例が挙げられます。 - パラメータの設定値が値域外の場合。 - 全角文字のみが使用できるパラメータで半角文字を使用している場合。 - パラメータに存在しないものを指定している場合。 |
401 Unauthorized |
アクセストークンに不正(期限切れ等)があります。 有効なアクセストークンを指定してください。 |
404 Not Found |
リクエストしたリソースが見つかりません。 URL及びHTTPメソッドを確認してください。 |
406 Not Acceptable |
Acceptヘッダの指定内容に不正があります。 Acceptヘッダの指定内容を確認してください。 |
413 Request Entity Too Large |
リクエストデータ全体のサイズが上限値を超過したため、処理を拒否しました。 リクエストデータを確認してください。 |
415 Unsupported Media Type |
リクエストに対応できないContent-Typeが指定されています。 Content-Typeヘッダの指定内容を確認してください。 |
500 internal Server Error |
サーバ内部でエラーが発生しました。 リクエストの内容を確認してください。その上で解決しない場合は、ご契約者様問い合わせよりお問い合わせください。 |
4.単語辞書登録
単語の読み方を定義したレコードを単語辞書に登録します。(日本語のみ)
デフォルトでうまく読み上げない単語を正しく読み上げさせることができます。
※登録可能な単語辞書レコード数の上限は5000件となります。
リクエスト
HTTPエンドポイント
POST [API Base URL]/tts/v1/dicts/word_dicts/{lang}
URIパラメータ
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
lang |
string |
必須 |
- |
言語種別 - ja_JP:日本語 |
リクエストヘッダ
キー名 | 必須 | 説明 |
---|---|---|
Content-Type |
必須 |
送信データのMIMEタイプ application/json; charset=UTF-8 |
Authorization |
必須 |
アクセストークン 以下のフォーマットで指定 Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
target |
string |
必須 |
- |
単語の表記 登録する単語の表記を指定します。 【制限】 最大文字数:45[文字] 表記のフォーマットは、入出力項目の単語の表記の項目を参照してください。 表記と品詞の組み合わせの重複登録はできません。 |
partOfSpeech |
string |
必須 |
- |
単語の品詞 登録する単語の品詞を指定します。 【制限】 指定可能な品詞は、入出力項目の指定可能な品詞を参照してください。 |
pronunciation |
string |
必須 |
- |
単語の読み 登録する単語の読みを指定します。 【制限】 最大文字数:45[文字] 空文字("pronunciation":"")を指定可能です。 空文字を指定した場合、当該単語に対しての音声合成は行われません。 読みのフォーマットは、入出力項目の単語の読み・アクセントの項目を参照してください。 |
リクエストサンプル(cURL)
curl -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Bearer [access token]" -d '{"target": "辞書/データ/1", "partOfSpeech": "普通名詞", "pronunciation": "ジショ/デ'\''ータ/イチ"}' [API Base URL]/tts/v1/dicts/word_dicts/ja_JP
レスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
Location |
作成リソース参照パス 作成した単語辞書レコードを対象としたURIです。 |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
dictDataId |
number(integer) |
作成された単語辞書レコードのID |
target |
string |
作成された単語辞書レコードの表記 |
partOfSpeech |
string |
作成された単語辞書レコードの品詞 |
pronunciation |
string |
作成された単語辞書レコードの読み |
createdAt |
string |
作成された単語辞書レコードの作成日時 RFC3339形式で表現されます。 |
updatedAt |
string |
作成された単語辞書レコードの更新日時 RFC3339形式で表現されます。 |
レスポンスサンプル
{ "dictDataId": 1, "target": "辞書/データ/1", "partOfSpeech": "普通名詞", "pronunciation": "ジショ/デ'ータ/イチ", "createdAt": "2019-07-01T11:25:49+09:00", "updatedAt": "2019-07-01T11:25:49+09:00" }
エラー時のレスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
code |
string |
エラーコード 問い合わせの際に利用します。 |
detail |
string |
エラー詳細 エラー内容についての情報です。詳細はエラー時のdetailの一覧と対処を参照してください。 |
HTTPステータスコード
レスポンスコード | 説明及び対処 |
---|---|
400 Bad Request |
入力パラメータに不正があります。 レスポンスボディのdetailキーの内容と、こちらを参考に、正しいパラメータの指定を行ってください。 ※入力パラメータの不正には以下の例が挙げられます。 - パラメータの設定値が値域外の場合。 - 全角文字のみが使用できるパラメータで半角文字を使用している場合。 - パラメータに存在しないものを指定している場合。 |
401 Unauthorized |
アクセストークンに不正(期限切れ等)があります。 有効なアクセストークンを指定してください。 |
404 Not Found |
リクエストしたリソースが見つかりません。 URL及びHTTPメソッドを確認してください。 |
406 Not Acceptable |
Acceptヘッダの指定内容に不正があります。 Acceptヘッダの指定内容を確認してください。 |
409 Conflict |
作成しようとしたレコードが競合しています。 作成しようとしたレコードの指定内容、または作成済みのレコードを確認してください。 |
413 Request Entity Too Large |
リクエストデータ全体のサイズが上限値を超過したため、処理を拒否しました。 リクエストデータを確認してください。 |
415 Unsupported Media Type |
リクエストに対応できないContent-Typeが指定されています。 Content-Typeヘッダの指定内容を確認してください。 |
500 internal Server Error |
サーバ内部でエラーが発生しました。 リクエストの内容を確認してください。その上で解決しない場合は、ご契約者様問い合わせよりお問い合わせください。 |
5.単語辞書一覧取得
単語辞書に登録されているレコードの一覧を取得します。(日本語のみ)
リクエスト
HTTPエンドポイント
GET [API Base URL]/tts/v1/dicts/word_dicts/{lang}?{target, dictDataId, page, limit, sort}
URIパラメータ
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
lang |
string |
必須 |
- |
言語種別 - ja_JP:日本語 |
target |
string |
任意 |
- |
表記 取得する辞書レコードの表記を指定します。 部分一致での検索が可能です。 【制限】 最大文字数:45[文字] ※空文字を指定した場合は、targetは無視されます。 |
dictDataId |
number(integer) |
任意 |
- |
レコードID 取得する辞書レコードのIDを指定します。 dictDataIdを指定した場合、必須パラメータ以外は無視されます。 ※空文字を指定した場合、dictDataIdは無視されます。 該当レコードが存在しないdictDataIdを指定した場合は、空の配列が返却されます。 |
page |
number(integer) |
任意 |
1 |
参照ページ番号 取得する辞書レコード一覧検索結果のページ番号を指定します。 【制限】 値域:1~5000 ※指定ページに該当レコードが存在しない場合は、空の配列を返却します。 |
limit |
number(integer) |
任意 |
25 |
1ページ当たりの取得件数 辞書レコード一覧検索結果の1ページ当たりの表示件数を指定します。 【制限】 値域:1~5000 ※登録されているデータ数がlimitの値に満たない場合、1ページ目で全てのデータを返却します。 |
sort |
string |
任意 |
createdAt |
項目のソート順序 取得する辞書データのソート順序を指定します。 指定可能なソート項目は以下の通りです。 - target:表記 - pronunciation:読み - createdAt:作成日時 - updatedAt:更新日時 デフォルトでは昇順ですが、各ソート項目の前に半角ハイフン(-)を付与することで降順の指定が可能です。 複数項目でソートする場合は、第1ソート項目から順に半角カンマ区切りで指定します。 例:sort=target,-createdAt |
リクエストヘッダ
キー名 | 必須 | 説明 |
---|---|---|
Content-Type |
必須 |
送信データのMIMEタイプ application/json; charset=UTF-8 |
Authorization |
必須 |
アクセストークン 以下のフォーマットで指定 Bearer [Access Token] |
リクエストサンプル(cURL)
・必須パラメータのみ
curl -H "Authorization: Bearer [access token]" [API Base URL]/tts/v1/dicts/word_dicts/ja_JP
・全てのパラメータを指定
curl -H "Authorization: Bearer [access token]" "[API Base URL]/tts/v1/dicts/word_dicts/ja_JP?target=辞書&page=1&limit=20&sort=target,-pronunciation,-createdAt,updatedAt"
レスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
X-Total-Count |
参照条件での全結果数 |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
dictData |
array[object] |
以下のキーを含む要素の配列 |
dictDataId |
number(integer) |
取得された単語辞書レコードのID |
target |
string |
取得された単語辞書レコードの表記 |
partOfSpeech |
string |
取得された単語辞書レコードの品詞 |
pronunciation |
string |
取得された単語辞書レコードの読み |
createdAt |
string |
取得された単語辞書レコードの作成日時 RFC3339形式で表現されます。 |
updatedAt |
string |
取得された単語辞書レコードの更新日時 RFC3339形式で表現されます。 |
レスポンスサンプル
{ dictData: [ { "dictDataId": 1, "target": "辞書/データ/1", "partOfSpeech": "普通名詞", "pronunciation: "ジショ/デ'ータ/イチ", "createdAt": "2019-07-01T11:25:49+09:00", "updatedAt": "2019-07-01T11:25:49+09:00" }, { "dictDataId": 2, "target": "辞書/データ/2", "partOfSpeech": "固有名詞", "pronunciation: "ジショ/デ'ータ/ニ", "createdAt": "2019-07-01T11:25:50+09:00", "updatedAt": "2019-07-01T11:25:50+09:00" } ] }
エラー時のレスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
code |
string |
エラーコード 問い合わせの際に利用します。 |
detail |
string |
エラー詳細 エラー内容についての情報です。詳細はエラー時のdetailの一覧と対処を参照してください。 |
HTTPステータスコード
レスポンスコード | 説明及び対処 |
---|---|
400 Bad Request |
入力パラメータに不正があります。 レスポンスボディのdetailキーの内容と、こちらを参考に、正しいパラメータの指定を行ってください。 ※入力パラメータの不正には以下の例が挙げられます。 - パラメータの設定値が値域外の場合。 - 全角文字のみが使用できるパラメータで半角文字を使用している場合。 - パラメータに存在しないものを指定している場合。 |
401 Unauthorized |
アクセストークンに不正(期限切れ等)があります。 有効なアクセストークンを指定してください。 |
404 Not Found |
リクエストしたリソースが見つかりません。 URL及びHTTPメソッドを確認してください。 |
406 Not Acceptable |
Acceptヘッダの指定内容に不正があります。 Acceptヘッダの指定内容を確認してください。 |
413 Request Entity Too Large |
リクエストデータ全体のサイズが上限値を超過したため、処理を拒否しました。 リクエストデータを確認してください。 |
415 Unsupported Media Type |
リクエストに対応できないContent-Typeが指定されています。 Content-Typeヘッダの指定内容を確認してください。 |
500 internal Server Error |
サーバ内部でエラーが発生しました。 リクエストの内容を確認してください。その上で解決しない場合は、ご契約者様問い合わせよりお問い合わせください。 |
6.単語辞書更新
単語辞書に登録されているレコードの更新を行います。(日本語のみ)
リクエスト
HTTPエンドポイント
PUT [API Base URL]/tts/v1/dicts/word_dicts/{lang}/{dictDataId}
URIパラメータ
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
lang |
string |
必須 |
- |
言語種別 - ja_JP:日本語 |
dictDataId |
number(integer) |
必須 |
- |
レコードID 更新する辞書レコードのIDを指定します。 |
リクエストヘッダ
キー名 | 必須 | 説明 |
---|---|---|
Content-Type |
必須 |
送信データのMIMEタイプ application/json; charset=UTF-8 |
Authorization |
必須 |
アクセストークン 以下のフォーマットで指定 Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
target |
string |
任意 |
- |
単語の表記 更新する単語の表記を指定します。 【制限】 最大文字数:45[文字] 表記のフォーマットは、入出力項目の単語の表記の項目を参照してください。 表記と品詞の組み合わせの重複登録はできません。 |
partOfSpeech |
string |
任意 |
- |
単語の品詞 更新する単語の品詞を指定します。 【制限】 指定可能な品詞は、入出力項目の指定可能な品詞を参照してください。 |
pronunciation |
string |
任意 |
- |
単語の読み 更新する単語の読みを指定します。 【制限】 最大文字数:45[文字] 空文字("pronunciation":"")を指定可能です。 空文字を指定した場合、当該単語に対しての音声合成は行われません。 読みのフォーマットは、入出力項目の単語の読み・アクセントの項目を参照してください。 |
※全てのキーを省略した場合、HTTPレスポンスコード「400 BadRequest」を返却します。
リクエストサンプル(cURL)
・表記のみ更新
curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer [access token]" -d '{"target": "辞書/データ/3"}' [API Base URL]/tts/v1/dicts/word_dicts/ja_JP/1
・全登録内容の更新
curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer [access token]" -d '{"target": "辞書/データ/4", "partOfSpeech": "名", "pronunciation": "ジショ/デ'\''ータ/ヨン"}' [API Base URL]/tts/v1/dicts/word_dicts/ja_JP/1
レスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
dictDataId |
number(integer) |
更新された単語辞書レコードのID |
target |
string |
更新された単語辞書レコードの表記 |
partOfSpeech |
string |
更新された単語辞書レコードの品詞 |
pronunciation |
string |
更新された単語辞書レコードの読み |
createdAt |
string |
更新された単語辞書レコードの作成日時 RFC3339形式で表現されます。 |
updatedAt |
string |
更新された単語辞書レコードの更新日時 RFC3339形式で表現されます。 |
レスポンスサンプル
{ "dictDataId": 1, "target": "辞書/データ/3", "partOfSpeech": "名", "pronunciation: "ジショ/デ'ータ/サン", "createdAt": "2019-07-01T11:25:49+09:00", "updatedAt": "2019-07-02T09:30:21+09:00" }
エラー時のレスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
code |
string |
エラーコード 問い合わせの際に利用します。 |
detail |
string |
エラー詳細 エラー内容についての情報です。詳細はエラー時のdetailの一覧と対処を参照してください。 |
HTTPステータスコード
レスポンスコード | 説明及び対処 |
---|---|
400 Bad Request |
入力パラメータに不正があります。 レスポンスボディのdetailキーの内容と、こちらを参考に、正しいパラメータの指定を行ってください。 ※入力パラメータの不正には以下の例が挙げられます。 - パラメータの設定値が値域外の場合。 - 全角文字のみが使用できるパラメータで半角文字を使用している場合。 - パラメータに存在しないものを指定している場合。 |
401 Unauthorized |
アクセストークンに不正(期限切れ等)があります。 有効なアクセストークンを指定してください。 |
404 Not Found |
リクエストしたリソースが見つかりません。 URL及びHTTPメソッドを確認してください。 |
406 Not Acceptable |
Acceptヘッダの指定内容に不正があります。 Acceptヘッダの指定内容を確認してください。 |
409 Conflict |
更新しようとしたレコードが競合しています。 更新しようとしたレコードの指定内容、または作成済みのレコードを確認してください。 |
413 Request Entity Too Large |
リクエストデータ全体のサイズが上限値を超過したため、処理を拒否しました。 リクエストデータを確認してください。 |
415 Unsupported Media Type |
リクエストに対応できないContent-Typeが指定されています。 Content-Typeヘッダの指定内容を確認してください。 |
500 internal Server Error |
サーバ内部でエラーが発生しました。 リクエストの内容を確認してください。その上で解決しない場合は、ご契約者様問い合わせよりお問い合わせください。 |
7.単語辞書削除
単語辞書に登録されているレコードの削除を行います。(日本語のみ)
リクエスト
HTTPエンドポイント
DELETE [API Base URL]/tts/v1/dicts/word_dicts/{lang}/{dictDataId}
URIパラメータ
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
lang |
string |
必須 |
- |
言語種別 - ja_JP:日本語 |
dictDataId |
number(integer) |
必須 |
- |
レコードID 削除する辞書レコードのIDを指定します。 |
リクエストヘッダ
キー名 | 必須 | 説明 |
---|---|---|
Content-Type |
必須 |
送信データのMIMEタイプ application/json; charset=UTF-8 |
Authorization |
必須 |
アクセストークン 以下のフォーマットで指定 Bearer [Access Token] |
X-HTTP-Method-Override |
任意 |
要求処理メソッド名 DELETE HTTPメソッドがPOSTの場合は必須です。 |
リクエストサンプル(cURL)
curl -X DELETE -H "Authorization: Bearer [access token]" [API Base URL]/tts/v1/dicts/word_dicts/ja_JP/1
レスポンス
HTTPステータスコード204(No Content)が返却されます。
エラー時のレスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
code |
string |
エラーコード 問い合わせの際に利用します。 |
detail |
string |
エラー詳細 エラー内容についての情報です。詳細はエラー時のdetailの一覧と対処を参照してください。 |
HTTPステータスコード
レスポンスコード | 説明及び対処 |
---|---|
400 Bad Request |
入力パラメータに不正があります。 レスポンスボディのdetailキーの内容と、こちらを参考に、正しいパラメータの指定を行ってください。 ※入力パラメータの不正には以下の例が挙げられます。 - パラメータの設定値が値域外の場合。 - 全角文字のみが使用できるパラメータで半角文字を使用している場合。 - パラメータに存在しないものを指定している場合。 |
401 Unauthorized |
アクセストークンに不正(期限切れ等)があります。 有効なアクセストークンを指定してください。 |
404 Not Found |
リクエストしたリソースが見つかりません。 URL及びHTTPメソッドを確認してください。 |
413 Request Entity Too Large |
リクエストデータ全体のサイズが上限値を超過したため、処理を拒否しました。 リクエストデータを確認してください。 |
415 Unsupported Media Type |
リクエストに対応できないContent-Typeが指定されています。 Content-Typeヘッダの指定内容を確認してください。 |
500 internal Server Error |
サーバ内部でエラーが発生しました。 リクエストの内容を確認してください。その上で解決しない場合はご契約者様問い合わせよりお問い合わせください。 |
8.文辞書登録
文章の読み方を定義したレコードを文辞書に登録します。デフォルトでうまく読み上げない文章を正しく読み上げさせることができます。(日本語のみ)
読み上げ方は読みテキストで定義します。
※登録可能な文辞書レコード数の上限は5000件となります。
リクエスト
HTTPエンドポイント
POST [API Base URL]/tts/v1/dicts/sentence_dicts/{lang}
URIパラメータ
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
lang |
string |
必須 |
- |
言語種別 - ja_JP:日本語 |
リクエストヘッダ
キー名 | 必須 | 説明 |
---|---|---|
Content-Type |
必須 |
送信データのMIMEタイプ application/json; charset=UTF-8 |
Authorization |
必須 |
アクセストークン 以下のフォーマットで指定 Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
target |
string |
必須 |
- |
文章の表記 登録する文章の表記をプレーンテキストで指定します。 【制限】 最大文字数:150[文字] 登録済みの表記と同じ表記のレコードは登録できません。 |
utterance |
string |
必須 |
- |
読みテキスト 登録する文章の読みを読みテキストで指定します。 【制限】 最大文字数:360[文字] 読みテキストのフォーマットは、入出力項目の読みテキストの項目を参照してください。 |
リクエストサンプル(cURL)
curl -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Bearer [access token]" -d '{"target": "これは文辞書データ1です。", "utterance": "コレワ[,00]ブンジショデータ[/05]イチデス^[.02]"}' [API Base URL]/tts/v1/dicts/sentence_dicts/ja_JP
レスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
Location |
作成リソース参照パス 作成した文辞書レコードを対象としたURIです。 |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
dictDataId |
number(integer) |
作成された文辞書レコードのID |
target |
string |
作成された文辞書レコードの表記 |
utterance |
string |
作成された文辞書レコードの読みテキスト |
createdAt |
string |
作成された文辞書レコードの作成日時 RFC3339形式で表現されます。 |
updatedAt |
string |
作成された文辞書レコードの更新日時 RFC3339形式で表現されます。 |
レスポンスサンプル
{ "dictDataId": 1, "target": "これは文辞書データ1です。", "utterance": "コレワ[,00]ブンジショデータ[/05]イチデス^[.02]", "createdAt": "2019-07-01T11:25:49+09:00", "updatedAt": "2019-07-01T11:25:49+09:00" }
エラー時のレスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
code |
string |
エラーコード 問い合わせの際に利用します。 |
detail |
string |
エラー詳細 エラー内容についての情報です。詳細はエラー時のdetailの一覧と対処を参照してください。 |
HTTPステータスコード
レスポンスコード | 説明及び対処 |
---|---|
400 Bad Request |
入力パラメータに不正があります。 レスポンスボディのdetailキーの内容と、こちらを参考に、正しいパラメータの指定を行ってください。 ※入力パラメータの不正には以下の例が挙げられます。 - パラメータの設定値が値域外の場合。 - 全角文字のみが使用できるパラメータで半角文字を使用している場合。 - パラメータに存在しないものを指定している場合。 |
401 Unauthorized |
アクセストークンに不正(期限切れ等)があります。 有効なアクセストークンを指定してください。 |
404 Not Found |
リクエストしたリソースが見つかりません。 URL及びHTTPメソッドを確認してください。 |
406 Not Acceptable |
Acceptヘッダの指定内容に不正があります。 Acceptヘッダの指定内容を確認してください。 |
409 Conflict |
作成しようとしたレコードが競合しています。 作成しようとしたレコードの指定内容、または作成済みのレコードを確認してください。 |
413 Request Entity Too Large |
リクエストデータ全体のサイズが上限値を超過したため、処理を拒否しました。 リクエストデータを確認してください。 |
415 Unsupported Media Type |
リクエストに対応できないContent-Typeが指定されています。 Content-Typeヘッダの指定内容を確認してください。 |
500 internal Server Error |
サーバ内部でエラーが発生しました。 リクエストの内容を確認してください。その上で解決しない場合はご契約者様問い合わせよりお問い合わせください。 |
9.文辞書一覧取得
文辞書に登録されているレコードの一覧を取得します。(日本語のみ)
リクエスト
HTTPエンドポイント
GET [API Base URL]/tts/v1/dicts/sentence_dicts/{lang}?{target, dictDataId, page, limit, sort}
URIパラメータ
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
lang |
string |
必須 |
- |
言語種別 - ja_JP:日本語 |
target |
string |
任意 |
- |
表記 取得する辞書レコードの表記を指定します。 部分一致での検索が可能です。 【制限】 最大文字数:150[文字] ※空文字を指定した場合は、targetは無視されます。 |
dictDataId |
number(integer) |
任意 |
- |
レコードID 取得する辞書レコードのIDを指定します。 dictDataIdを指定した場合、必須パラメータ以外は無視されます。 ※空文字を指定した場合、dictDataIdは無視されます。 該当レコードが存在しないdictDataIdを指定した場合は、空の配列が返却されます。 |
page |
number(integer) |
任意 |
1 |
参照ページ番号 取得する辞書レコード一覧検索結果のページ番号を指定します。 【制限】 値域:1~5000 ※指定ページに該当レコードが存在しな場合は、空の配列を返却します。 |
limit |
number(integer) |
任意 |
25 |
1ページ当たりの取得件数 辞書レコード一覧検索結果の1ページ当たりの表示件数を指定します。 【制限】 値域:1~5000 ※登録されているデータ数がlimitの値に満たない場合、1ページ目で全てのデータを返却します。 |
sort |
string |
任意 |
createdAt |
項目のソート順序 取得する辞書データのソート順序を指定します。 指定可能なソート項目は以下の通りです。 - target:表記 - utterance:読みテキスト - createdAt:作成日時 - updatedAt:更新日時 デフォルトでは昇順ですが、各ソート項目の前に半角ハイフン(-)を付与することで降順の指定が可能です。 複数項目でソートする場合は、第1ソート項目から順に半角カンマ区切りで指定します。 例:sort=target,-createdAt |
リクエストヘッダ
キー名 | 必須 | 説明 |
---|---|---|
Content-Type |
必須 |
送信データのMIMEタイプ application/json; charset=UTF-8 |
Authorization |
必須 |
アクセストークン 以下のフォーマットで指定 Bearer [Access Token] |
リクエストサンプル(cURL)
・必須パラメータのみ
curl -H "Authorization: Bearer [access token]" [API Base URL]/tts/v1/dicts/sentence_dicts/ja_JP
・全パラメータを指定
curl -H "Authorization: Bearer [access token]" "[API Base URL]/tts/v1/dicts/sentence_dicts/ja_JP?target=辞書&page=1&limit=20&sort=target,-utterance,-createdAt,updatedAt"
レスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
X-Total-Count |
参照条件での全結果数 |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
dictData |
array[object] |
以下のキーを含む要素の配列 |
dictDataId |
number(integer) |
取得された文辞書レコードのID |
target |
string |
取得された文辞書レコードの表記 |
utterance |
string |
取得された文辞書レコードの読みテキスト |
createdAt |
string |
取得された文辞書レコードの作成日時 RFC3339形式で表現されます。 |
updatedAt |
string |
取得された文辞書レコードの更新日時 RFC3339形式で表現されます。 |
レスポンスサンプル
{ dictData: [ { "dictDataId": 1, "target": "これは文辞書データ1です。", "utterance": "コレワ[,00]ブンジショデータ[/05]イチデス^[.02]", "createdAt": "2019-07-01T11:25:49+09:00", "updatedAt": "2019-07-02T09:30:21+09:00" }, { "dictDataId": 2, "target": "辞書/データ/2", "utterance": "コレワ[,00]ブンジショデータ[/05]ニデス^[.02]", "createdAt": "2019-07-01T11:26:30+09:00", "updatedAt": "2019-07-01T11:26:30+09:00" } ] }
エラー時のレスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
code |
string |
エラーコード 問い合わせの際に利用します。 |
detail |
string |
エラー詳細 エラー内容についての情報です。詳細はエラー時のdetailの一覧と対処を参照してください。 |
HTTPステータスコード
レスポンスコード | 説明及び対処 |
---|---|
400 Bad Request |
入力パラメータに不正があります。 レスポンスボディのdetailキーの内容と、こちらを参考に、正しいパラメータの指定を行ってください。 ※入力パラメータの不正には以下の例が挙げられます。 - パラメータの設定値が値域外の場合。 - 全角文字のみが使用できるパラメータで半角文字を使用している場合。 - パラメータに存在しないものを指定している場合。 |
401 Unauthorized |
アクセストークンに不正(期限切れ等)があります。 有効なアクセストークンを指定してください。 |
404 Not Found |
リクエストしたリソースが見つかりません。 URL及びHTTPメソッドを確認してください。 |
406 Not Acceptable |
Acceptヘッダの指定内容に不正があります。 Acceptヘッダの指定内容を確認してください。 |
413 Request Entity Too Large |
リクエストデータ全体のサイズが上限値を超過したため、処理を拒否しました。 リクエストデータを確認してください。 |
415 Unsupported Media Type |
リクエストに対応できないContent-Typeが指定されています。 Content-Typeヘッダの指定内容を確認してください。 |
500 internal Server Error |
サーバ内部でエラーが発生しました。 リクエストの内容を確認してください。その上で解決しない場合は、ご契約者様問い合わせよりお問い合わせください。 |
10.文辞書更新
文辞書に登録されているレコードの更新を行います。(日本語のみ)
リクエスト
HTTPエンドポイント
PUT [API Base URL]/tts/v1/dicts/sentence_dicts/{lang}/{dictDataId}
URIパラメータ
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
lang |
string |
必須 |
- |
言語種別 - ja_JP:日本語 |
dictDataId |
number(integer) |
必須 |
- |
レコードID 更新する辞書レコードのIDを指定します。 |
リクエストヘッダ
キー名 | 必須 | 説明 |
---|---|---|
Content-Type |
必須 |
送信データのMIMEタイプ application/json;charset=UTF-8 |
Authorization |
必須 |
アクセストークン 以下のフォーマットで指定 Bearer [Access Token] |
X-HTTP-Method-Override |
任意 |
要求処理メソッド名 PUT HTTPメソッドがPOSTの場合は必須です。 |
リクエストボディ
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
target |
string |
任意 |
- |
文章の表記 更新する文章の表記をプレーンテキストで指定します。 【制限】 最大文字数:150[文字] 登録済みの表記と同じ表記のレコードは登録できません。 |
utterance |
string |
必須 |
- |
読みテキスト 更新する文章の読みを読みテキストで指定します。 【制限】 最大文字数:360[文字] 読みテキストのフォーマットは、入出力項目の読みテキストの項目を参照してください。 |
※全てのキーを省略した場合、HTTPレスポンスコード「400 BadRequest」を返却します。
リクエストサンプル(cURL)
・表記のみ更新
curl -X PUT -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Bearer [access token]" -d '{"target": "これは文辞書データ3です。"}' [API Base URL]/tts/v1/dicts/sentence_dicts/ja_JP/1
・全登録内容の更新
curl -X PUT -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Bearer [access token]" -d '{"target": "これは文辞書データ4です。", "utterance": "コレワ[,00]ブンジショデータ[/05]ヨンデス^[.03]"}' [API Base URL]/tts/v1/dicts/sentence_dicts/ja_JP/1
レスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
dictDataId |
number(integer) |
更新された文辞書レコードのID |
target |
string |
更新された文辞書レコードの表記 |
utterance |
string |
更新された文辞書レコードの読みテキスト |
createdAt |
string |
更新された文辞書レコードの作成日時 RFC3339形式で表現されます。 |
updatedAt |
string |
更新された文辞書レコードの更新日時 RFC3339形式で表現されます。 |
レスポンスサンプル
{ "dictDataId": 1, "target": "これは文辞書データ3です。", "utterance": "コレワ[,00]ブンジショデータ[/05]サンデス^[.03]", "createdAt": "2019-07-01T11:25:49+09:00", "updatedAt": "2019-07-02T09:30:21+09:00" }
エラー時のレスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
code |
string |
エラーコード 問い合わせの際に利用します。 |
detail |
string |
エラー詳細 エラー内容についての情報です。詳細はエラー時のdetailの一覧と対処を参照してください。 |
HTTPステータスコード
レスポンスコード | 説明及び対処 |
---|---|
400 Bad Request |
入力パラメータに不正があります。 レスポンスボディのdetailキーの内容と、こちらを参考に、正しいパラメータの指定を行ってください。 ※入力パラメータの不正には以下の例が挙げられます。 - パラメータの設定値が値域外の場合。 - 全角文字のみが使用できるパラメータで半角文字を使用している場合。 - パラメータに存在しないものを指定している場合。 |
401 Unauthorized |
アクセストークンに不正(期限切れ等)があります。 有効なアクセストークンを指定してください。 |
404 Not Found |
リクエストしたリソースが見つかりません。 URL及びHTTPメソッドを確認してください。 |
406 Not Acceptable |
Acceptヘッダの指定内容に不正があります。 Acceptヘッダの指定内容を確認してください。 |
409 Conflict |
更新しようとしたレコードが競合しています。 更新しようとしたレコードの指定内容、または作成済みのレコードを確認してください。 |
413 Request Entity Too Large |
リクエストデータ全体のサイズが上限値を超過したため、処理を拒否しました。 リクエストデータを確認してください。 |
415 Unsupported Media Type |
リクエストに対応できないContent-Typeが指定されています。 Content-Typeヘッダの指定内容を確認してください。 |
500 internal Server Error |
サーバ内部でエラーが発生しました。 リクエストの内容を確認してください。その上で解決しない場合は、ご契約者様問い合わせよりお問い合わせください。 |
11.文辞書削除
文辞書に登録されているレコードの削除を行います。(日本語のみ)
リクエスト
HTTPエンドポイント
DELETE [API Base URL]/tts/v1/dicts/sentence_dicts/{lang}/{dictDataId}
URIパラメータ
キー名 | データ型 | 必須 | デフォルト値 | 説明 |
---|---|---|---|---|
lang |
string |
必須 |
- |
言語種別 - ja_JP:日本語 |
dictDataId |
number(integer) |
必須 |
- |
レコードID 削除する辞書レコードのIDを指定します。 |
リクエストヘッダ
キー名 | 必須 | 説明 |
---|---|---|
Content-Type |
必須 |
送信データのMIMEタイプ application/json;charset=UTF-8 |
Authorization |
必須 |
アクセストークン 以下のフォーマットで指定 Bearer [Access Token] |
X-HTTP-Method-Override |
任意 |
要求処理メソッド名 DELETE HTTPメソッドがPOSTの場合は必須です。 |
リクエストサンプル(cURL)
curl -X DELETE -H "Authorization: Bearer [access token]" [API Base URL]/tts/v1/dicts/sentence_dicts/ja_JP/1
レスポンス
HTTPステータスコード204(No Content)が返却されます。
エラー時のレスポンス
レスポンスヘッダ
キー名 | 説明 |
---|---|
Content-Type |
受信データのMIMEタイプ application/json |
レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
code |
string |
エラーコード 問い合わせの際に利用します。 |
detail |
string |
エラー詳細 エラー内容についての情報です。詳細はエラー時のdetailの一覧と対処を参照してください。 |
HTTPステータスコード
レスポンスコード | 説明及び対処 |
---|---|
400 Bad Request |
入力パラメータに不正があります。 レスポンスボディのdetailキーの内容と、こちらを参考に、正しいパラメータの指定を行ってください。 ※入力パラメータの不正には以下の例が挙げられます。 - パラメータの設定値が値域外の場合。 - 全角文字のみが使用できるパラメータで半角文字を使用している場合。 - パラメータに存在しないものを指定している場合。 |
401 Unauthorized |
アクセストークンに不正(期限切れ等)があります。 有効なアクセストークンを指定してください。 |
404 Not Found |
リクエストしたリソースが見つかりません。 URL及びHTTPメソッドを確認してください。 |
413 Request Entity Too Large |
リクエストデータ全体のサイズが上限値を超過したため、処理を拒否しました。 リクエストデータを確認してください。 |
415 Unsupported Media Type |
リクエストに対応できないContent-Typeが指定されています。 Content-Typeヘッダの指定内容を確認してください。 |
500 internal Server Error |
サーバ内部でエラーが発生しました。 リクエストの内容を確認してください。その上で解決しない場合は、ご契約者様問い合わせよりお問い合わせください。 |
入出力項目(データ仕様)
音声合成対象テキスト
音声合成の対象となるテキストデータです。一括音声合成、逐次音声合成、読み解析を使用する場合に用います。
プレーンテキスト
漢字や平仮名、片仮名、アルファベットなどが混在した平文テキストデータです。
※英語話者を使用する場合は、プレーンテキストに指定できるのは半角英数記号のみとなります。
プレーンテキストのデータ構成
プレーンテキスト
プレーンテキストのデータ構成要素
項目 | 説明 | データ型[文字種] | 最大サイズ | 値域 | 省略 |
---|---|---|---|---|---|
プレーンテキスト |
UTF-8で表現可能なテキスト 上記に示した文字コード制限を満たさなかった場合、音声合成、読み解析において下記の結果が生じることがあります。 - エラーになる - 期待と異なる結果になる |
string[全角半角] |
500[文字] |
- |
不可 |
サンプル
今日はいい天気ですね。明日も晴れです。
読みテキスト
読みテキストとは、読み方とアクセント・声調などを表現した独自形式の平文を指します。読みテキストは言語種別毎に異なるフォーマットを定義しています。
読みテキストのフォーマット
テキストの読みとアクセント位置、結合型を全角片仮名と記号、数値により表現するものです。
読みテキストは、アクセント句、結合型、アクセント位置のまとまりを1つ以上含んで、以下のように構成されます。
アクセント句[結合型アクセント位置]…アクセント句[結合型アクセント位置]
読みテキストのデータ構成要素
項目 | 説明 | データ型[文字種] | 文字数 | 値域 | 省略 |
---|---|---|---|---|---|
アクセント句 |
アクセントを高々1つもつ、文章の部分の読みを「モーラ単位の片仮名」の連結で表現します。 指定できる「モーラ単位の片仮名」は99個までです。 「モーラ単位の片仮名」に、無声化記号の半角ハット(^)を付与した場合、無声化されます。 例:「シュ^」 無声化できない「モーラ単位の片仮名」に、無声化記号を付与した場合はエラーとなります。 無声化記号(^) と長音記号(ー) を繋げて記述することはできません。 例: - OK:「ピー」 - NG:「ピ^ー」 使用可能な「モーラ単位の片仮名」については、読みテキストに使用可能なモーラ単位の片仮名を参照してください。無声化可能な「モーラ単位の片仮名」は、読みテキストに使用可能なモーラ単位の片仮名において灰色のセルとなっているものとなります。 |
string[全角半角] |
不定 |
- |
不可 |
結合型 |
以下の7種類が存在し、用途に合わせて指定することができます。 - 「/(半角スラッシュ)」、「*(半角アスタリスク)」:直後のアクセント句の抑揚を抑制する結合方法を指定します。これらは読みテキストの末尾に指定することはできません。 - %(半角パーセント):極小ポーズを指定します。 - △(半角スペース):アクセント句間に挿入する規定サイズのポーズ(小ポーズ)を指定します。 - ,(半角カンマ):読点「、」に対応したポーズ(中ポーズ)を指定します。 - .(半角ピリオド):句点「。」に対応したポーズ(大ポーズ)を指定します。 - ?(半角クエスチョンマーク):直前アクセント句の疑問口調の作成、及びポーズ(大ポーズ)を指定します。 |
string[半角記号] |
1 |
- |
不可 |
アクセント位置 |
アクセントのある「モーラ単位の片仮名」のアクセント句先頭からの位置を半角数字二桁で指定します。"00"を指定した場合、アクセント無しになります。 例:「ワッカナイ[,03]」→"カ"にアクセント |
number(integer)[半角数字] |
2 |
00~99 |
不可 |
いくつかの例文について、プレーンテキストとそれに対応したデフォルト設定における読みテキストを以下に列挙します。
プレーンテキスト1:今日はいい天気です。 読みテキスト1:キョーワ[/01]イー[/01]テンキデス^[.01] プレーンテキスト2:誕生日は10月31日です。 読みテキスト2:タンジョービワ[,03]ジューガツ[/04]サンジュー[*01]イチニチデス^[.04] プレーンテキスト3:出身はどちらですか? 読みテキスト3:シュ^ッシンワ[,00]ドチラデス^カ[?01]
読みテキストに使用可能なモーラ単位の片仮名
ア | ヴァ | カ | ガ | クァ | サ | ザ | タ | ダ | ツァ | ナ | ハ | バ | パ | ファ | マ | ヤ | ラ |
イ | ヴィ | キ | ギ | クィ | スィ | ズィ | ティ | ディ | ツィ | ニ | ビ | ピ | フィ | ミ | リ | ||
ウ | ヴ | ク | グ | ス | ズ | トゥ | ドゥ | ツ | ヌ | ブ | プ | フ | ム | ユ | ル | ||
エ | ヴェ | ケ | ゲ | クェ | セ | ゼ | テ | デ | ツェ | ネ | ヘ | ベ | ペ | フェ | メ | レ | |
オ | ヴォ | コ | ゴ | クォ | ソ | ゾ | ト | ド | ツォ | ノ | ホ | ボ | ポ | フォ | モ | ヨ | ロ |
ワ | キャ | ギャ | シャ | ジャ | チャ | ヂャ | ヅャ | ニャ | ヒャ | ビャ | ピャ | フャ | ミャ | リャ | ー | ||
ウィ | シ | ジ | チ | ヂ | ヅィ | ヒ | |||||||||||
キュ | ギュ | シュ | ジュ | チュ | ヂュ | ヅ | デュ | デュ | ニュ | ヒュ | ビュ | ピュ | フュ | ミュ | リュ | ッ | |
ウェ | シェ | ジェ | チェ | ヂェ | ヅェ | ヒェ | |||||||||||
ウォ | キョ | ギョ | ショ | ジョ | チョ | ヂョ | ヅォ | ニョ | ヒョ | ビョ | ピョ | フョ | ミョ | リョ | ン |
話者ID一覧
カテゴリ | 話者名 | 話者ID(speakerId) | 属性 |
---|---|---|---|
日本語/男性/大人 |
日本語/男性/大人/01 |
ja_JP-M-S0001-T001-E01-SR0 |
- |
日本語/男性/大人/02 |
ja_JP-M-S0005-T001-E01-SR0 |
- |
|
日本語/男性/大人/03 |
ja_JP-M-S0010-T001-E01-SR0 |
- |
|
日本語/男性/大人/04 |
ja_JP-M-S0013-T001-E01-SR0 |
- |
|
日本語/女性/大人 |
日本語/女性/大人/01 |
ja_JP-F-S0005-T002-E01-SR0 |
- |
日本語/女性/大人/02 |
ja_JP-F-S0008-T001-E01-SR0 |
- |
|
日本語/女性/大人/03 |
ja_JP-F-S0014-T001-E01-SR0 |
- |
|
日本語/女性/大人/04 |
ja_JP-F-S0015-T001-E01-SR0 |
- |
|
日本語/男性/子供 |
日本語/男性/子供/01 |
ja_JP-M-S0004-T001-E01-SR0 |
- |
日本語/女性/子供 |
日本語/女性/子供/01 |
ja_JP-F-S0006-T001-E01-SR0 |
- |
日本語/男性/キャラクター |
日本語/男性/キャラクター/01 |
ja_JP-M-S0002-T002-E01-SR0 |
執事 |
日本語/男性/キャラクター/02 |
ja_JP-M-S0139-T001-E01-SR0 |
アナウンサー |
|
日本語/女性/キャラクター |
日本語/男性/キャラクター/01 |
ja_JP-F-S0001-T003-E01-SR0 |
アニメ風 |
日本語/女性/キャラクター/02 |
ja_JP-F-S0140-T001-E01-SR0 |
アナウンサー |
|
英語/男性/大人 |
英語/男性/大人/01 |
en_US-M-S0001-T001-E01-SR0 |
- |
英語/女性/大人 |
英語/女性/大人/01 |
en_US-F-S0001-T001-E01-SR0 |
- |
単語辞書に関して
単語の表記
登録する単語の表記を全角文字(スペースを含む)で指定します。
複数の表記を半角スラッシュ(/)で区切ってまとめ、一つの表記として指定できます。まとめられる複数の表記のそれぞれについてアクセント位置を指定することで、一つの表記に対して複数のアクセント位置を指定することができるようになります。
この場合、後続の読みも同様に半角スラッシュで区切り、指定する必要があります。
例:
・表記:東京都/水道局
・読み:トーキョ'ート/スイド'ーキョク
単語の読み・アクセント
登録する単語の読みを「モーラ単位の片仮名」で指定します。
「モーラ単位の片仮名」の直後に半角アポストロフィ(')を挿入することで、該当の「モーラ単位の片仮名」にアクセント位置を指定できます。アクセント位置は、一つの読みにつき1つまで指定することができます。
「モーラ単位の片仮名」に、無声化記号の半角ハット(^)を付与した場合、無声化されます。 例:「シュ^」
無声化できない「モーラ単位の片仮名」に、無声化記号を付与した場合はエラーとなります。
無声化記号(^) と長音記号(ー) を繋げて記述することはできません。
例:
OK:「ピー」
NG:「ピ^ー」
使用可能な「モーラ単位の片仮名」については、読みテキストに使用可能なモーラ単位の片仮名を参照してください。無声化可能な「モーラ単位の片仮名」は、読みテキストに使用可能なモーラ単位の片仮名において灰色のセルとなっているものとなります。
表記にて半角スラッシュを使用している場合、読みにも同数の半角スラッシュ、および読みの指定が必要です。この場合、読みごとにアクセント位置の指定が可能です。 なお半角スラッシュは、連続して指定、または先頭・末尾位置に指定することはできません。
例:
OK:「ヨミ/テキスト」
NG:「/ヨミテキスト」, 「ヨミテキスト/」, 「ヨミ//テキスト」
指定可能な品詞
品詞名 | 説明 | 例 |
---|---|---|
普通名詞 |
普通名詞です。 |
うぐいす、アート、花火、学校 |
固有名詞 |
固有名詞全般です。 |
WINDOWS |
姓 |
人名の姓に使われる名詞です。 |
鈴木、山田 |
名 |
人名の名に使われる名詞です。 |
ひろし、一郎 |
地名 |
地名です。 |
東京、横浜 |
組織名 |
組織の名称です。 |
NTT |
サ変名詞 |
サ変名詞です。後ろに「する」をつけて動詞になります。 |
学習、カット、発展 |
エラー時のdetailの一覧と対処
detail | 対処 | 備考 |
---|---|---|
invalid Content-Type |
Content-Typeヘッダ不正。 |
- |
invalid Accept header value |
Acceptヘッダ不正。 |
- |
X-HTTP-Method-Override not exist |
X-HTTP-Method-Overrideヘッダの必要なAPIでX-HTTP-Method-Overrideが省略されました。 |
- |
Company-ID is invalid |
不正な個社IDが指定されました。 |
- |
specified URL not exist |
存在しないURLが指定されました。 |
- |
enter correct URL |
指定されたリソースがありませんでした。 |
- |
there is no item to delete |
指定されたリソースが存在しないため、削除できませんでした。 |
- |
warn.invalidUrl |
存在しないURLが指定されました。 |
- |
Cannot parse parameter dictDataId as Long: For input string: {value} |
存在しない辞書データのURLが指定されました。 |
{value}:値 |
Cannot parse parameter id as Long: For input string: {value} |
存在しない辞書データのURLが指定されました。 |
{value}:値 |
Error decoding json body: null |
リクエストボディのJSONが指定されていません。 |
- |
request containing invalid parameters |
リクエストボディのJSONのパースに失敗しました。 |
- |
{key} : invalid type({type}) |
{key}に不正な変数型の値が指定されました。 |
{key}:キー |
{key} : invalid key was specified. |
不正な{key}が指定されました。 |
{key}:キー |
{key} : must not be blank |
値の省略不可能な{key}が省略されました。 |
{key}:キー |
{key} : must not be null |
{key}の値にnullが指定されました。 |
{key}:キー |
{key} : must not be empty |
{key}に空の値が指定されました。 |
{key}:キー |
{key} : {value} is invalid |
{key}に不正な値{value}が指定されました。 |
{key}:キー |
{key} : Invalid value |
{key}に不正な値が指定されました。 |
{key}:キー |
{key} : invalid format |
{key}の値が不正な形式で指定されました。 |
{key}:キー |
{key} : must match "{regexp}" |
{regexp}の表現 にマッチしない値が指定されました。 |
{regexp}の表現 に従った値を指定してください。 |
{key} : must be greater than or equal to {value} |
{value}より小さい値が指定されました。 |
{key}:キー |
{key} : must be less than or equal to {value} |
{value}より大きい値が指定されました。 |
{key}:キー |
{key} : must be less than {value} character |
{key}に{value}より長い文字数が指定されました。 |
{key}:キー |
{key} : empty list is not acceptable |
{key}の値に空の配列が指定されました。 |
{key}:キー |
{key} : must be between {min} and {max} |
{key}に{min} ~ {max} の範囲外の値が指定されました。 |
{key}:キー |
{key} : size must be between {min} and {max} |
{key}に{min} ~ {max} の範囲外の文字列の長さが指定されました。 |
{key}:キー |
text : required input item |
読み解析処理の結果、読み上げるテキストが空となりました。 |
- |
text : Utterance Text NG. |
不正な読みテキストが指定されました。 |
- |
text : text analyzed result will be more than 1,200 characters |
読み解析処理の結果、読みテキストが1,200文字を超過しました。 |
- |
update field is not exist |
更新用APIのBody部に値が指定されていません。 |
- |
specified item not exist in the dictionary linked to the dict_id |
存在しない辞書データIDが指定されました。 |
- |
the request could not be completed due to a conflict {key}: {value} |
{key} の {value} が既存データと重複しました。 |
{key}:キー |
the request could not be completed due to a conflict with the current state of the resource |
指定されたデータが既存データと重複しました。 |
- |
error ocurred when Speech Synthesis({content}) |
読み解析処理の結果、不正な読みテキストとなりました。 |
{content}:内容 |
error ocurred when Text Analyzing({content}) |
読み解析処理が失敗しました。 |
{content}:内容 |
server encountered an internal error which prevented it from fulfilling this request |
ご契約者様問い合わせよりお問い合わせください。 |
※システム内部エラー発生 |
dict {dictType} is not found. |
辞書が存在しません。 |
{dictType}:辞書種別 |
could not parse response body |
ご契約者様問い合わせよりお問い合わせください。 |
※音声合成サーバから不明なエラーが返却 |
要約
日本語モデル・英語モデル
入力として日本語・英語で記述された文章を受け取り、入力時に指定された文字数又は文数に応じた、要約文を返します。
リクエスト
HTTPエンドポイント
POST [API Base URL]/nlp/v1/summary
リクエストヘッダ
キー名 | 必須 | 説明 |
---|---|---|
Content-Type |
必須 |
application/json;charset=UTF-8 |
Authorization |
必須 |
Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | 説明 |
---|---|---|---|
document |
string |
必須 |
10文字以上5000文字以下の入力文章 |
mode |
string |
必須 |
要約方法 |
sent_len |
number(integer) |
任意 |
要約文数(1〜100) |
char_len |
number(integer) |
任意 |
要約文字数(10〜2500) |
lang |
string |
任意 |
要約言語 |
percentage |
number(integer) |
任意 |
圧縮率(パーセンテージ)(1〜99) |
keywords |
string |
任意 |
キーワード |
viewpoint |
string |
任意 |
観点指定 |
リクエストサンプル(cURL)
curl -X POST -H 'Content-Type:application/json;charset=UTF-8' -H 'Authorization:Bearer [Access Token]' -d '{"document":"前線が太平洋上に停滞しています。一方、高気圧が千島近海にあって、北日本から東日本をゆるやかに覆っています。関東地方は、晴れ時々曇り、ところにより雨となっています。東京は、湿った空気や前線の影響により、晴れ後曇りで、夜は雨となるでしょう。","mode":"extract","sent_len":1,"lang":"ja"}' [API Base URL]/nlp/v1/summary
レスポンス
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
result |
string |
結果 |
status |
number(integer) |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
レスポンスサンプル
{ "result": "東京は、湿った空気や前線の影響により、晴れ後曇りで、夜は雨となるでしょう。", "status": 0, "message": "ok" }
コンタクトセンターモデル
入力として日本語で記述された応対記録文章を受け取り、入力時に指定された文字数又は文数に応じた、要約文を返します。
リクエスト
HTTPエンドポイント
POST [API Base URL]/nlp/v1/summary
リクエストヘッダ
キー名 | 必須 | 説明 |
---|---|---|
Content-Type |
必須 |
application/json;charset=UTF-8 |
Authorization |
必須 |
Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | 説明 |
---|---|---|---|
document |
string |
必須 |
10文字以上5000文字以下の入力文章 |
mode |
string |
必須 |
要約方法 |
sent_len |
number(integer) |
任意 |
要約文数(1〜100) |
char_len |
number(integer) |
任意 |
要約文字数(10〜2500) |
lang |
string |
不要 |
コンタクトセンターモデルをご利用の場合は不要 |
percentage |
number(integer) |
任意 |
圧縮率(パーセンテージ)(1〜99) |
keywords |
string |
任意 |
キーワード |
viewpoint |
string |
任意 |
観点指定 |
リクエストサンプル(cURL)
curl -X POST -H 'Content-Type:application/json;charset=UTF-8' -H 'Authorization:Bearer [Access Token]' -d '{"document":"お待たせ致しました。お問い合わせ頂き有難うございます。Aがお伺い致します。昨日の夕方、ウェブから御社の商品を申込みしました。そのあと、もう1つあったほうがよいと考えてウェブを見たところ、同じものがセットになった商品があることに気がつきました。そちらを申し込めば良かったのですが、その時点で問い合わせ時間が過ぎていたため、今電話しました。セット商品に変更していただくことはできるでしょうか。弊社商品をお申込み頂き有難うございます。お申し込み後のキャンセルや変更の手続きはウェブページからも行って頂くことができます。昨日の申込みということなら、お客様ご自身でウェブページで手続きされた方が簡単です。こちらの窓口で変更する場合は、本人様の確認のための作業を必要とするため、お手続きに時間がかかってしまいます。ウェブページで変更の申込みを実施いただけますでしょうか。ということはウェブから通常の手続きということですね。いつまでならお手続き可能でしょうか。本日中なら変更可能となりますので、本日中にお手続きください。わかりました。ありがとうございました。","mode":"extract-cc","sent_len":"5"}' [API Base URL]/nlp/v1/summary
応対記録を要約するための入力文章
要約したい応対記録文章から、要約するために最適な入力文章を作成します。
応対記録の例文
オペレータ : お待たせ致しました。お問い合わせ頂き有難うございます。Aがお伺い致します。 カスタマー : 昨日の夕方、ウェブから御社の商品を申込みしました。そのあと、もう1つあったほうがよいと考えてウェブを見たところ、同じものがセットになった商品があることに気がつきました。そちらを申し込めば良かったのですが、その時点で問い合わせ時間が過ぎていたため、今電話しました。セット商品に変更していただくことはできるでしょうか。 オペレータ : 弊社商品をお申込み頂き有難うございます。お申し込み後のキャンセルや変更の手続きはウェブページからも行って頂くことができます。昨日の申込みということなら、お客様ご自身でウェブページで手続きされた方が簡単です。こちらの窓口で変更する場合は、本人様の確認のための作業を必要とするため、お手続きに時間がかかってしまいます。ウェブページで変更の申込みを実施いただけますでしょうか。 カスタマー : ということはウェブから通常の手続きということですね。いつまでならお手続き可能でしょうか。 オペレータ : 本日中なら変更可能となりますので、本日中にお手続きください。 カスタマー : わかりました。ありがとうございました。
上記の応対記録を要約したい場合、発話者の識別子を除去した後、時系列に文章をつなげることにより一つの文章を作成します。
入力文章の作成例文
お待たせ致しました。お問い合わせ頂き有難うございます。Aがお伺い致します。昨日の夕方、ウェブから御社の商品を申込みしました。そのあと、もう1つあったほうがよいと考えてウェブを見たところ、同じものがセットになった商品があることに気がつきました。そちらを申し込めば良かったのですが、その時点で問い合わせ時間が過ぎていたため、今電話しました。セット商品に変更していただくことはできるでしょうか。弊社商品をお申込み頂き有難うございます。お申し込み後のキャンセルや変更の手続きはウェブページからも行って頂くことができます。昨日の申込みということなら、お客様ご自身でウェブページで手続きされた方が簡単です。こちらの窓口で変更する場合は、本人様の確認のための作業を必要とするため、お手続きに時間がかかってしまいます。ウェブページで変更の申込みを実施いただけますでしょうか。ということはウェブから通常の手続きということですね。いつまでならお手続き可能でしょうか。本日中なら変更可能となりますので、本日中にお手続きください。わかりました。ありがとうございました。
レスポンス
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
result |
string |
結果 |
status |
number(integer) |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
レスポンスサンプル
{ "result": "セット商品に変更していただくことはできるでしょうか。お申し込み後のキャンセルや変更の手続きウェブページからも行って頂くことができます。ウェブページで変更の申し込みを実施いただけますでしょうか。いつまでならお手続き可能でしょうか。本日中なら変更可能となりますので、本日中にお手続きください。", "status": 0, "message": "ok" }
入出力項目
エラーコード一覧
レスポンスコード | エラーコード | 説明 |
---|---|---|
200 |
0 |
正常終了。 |
400 |
17001 |
・リクエストデータがJSON形式ではない場合に発生。 ・リクエストデータのバリデーションチェックでエラーが発生。 |
401~4xx 5xx |
17xxx |
システム内部エラー |
テキスト分類
テキスト分類は以下の5つのAPIで構成されます。
なお、Developers環境アカウントでは、本APIをご利用いただけませんのでご了承ください。
・モデル生成API
クラスとテキストを含むテキストファイルを入力として、新しい分類モデルを生成します。
・モデル分類API
指定したモデルを利用して、テキストが属するクラスを出力します。
・モデル一覧API
作成した全モデル情報を出力します。
・モデル確認API
指定したモデルの学習状況や精度を出力します。
・モデル削除API
指定したモデルを削除します。
モデル生成API
リクエスト
HTTPエンドポイント
POST [API Base URL]/nlp/v1/classifier/models
リクエストヘッダ
キー名 | 説明 |
---|---|
Content-Type |
multipart/form-data |
Authorization |
Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | 説明 |
---|---|---|---|
dataset |
FILE |
必須 |
学習対象であるcsvファイル(ファイルパス) 【ファイルに関する制限事項】 ファイルサイズ:10MB以内 ファイル行数:1万行以内以内 各データのクラス文字数:80文字以内 各データのテキスト文字数:3000文字以内かつテキスト中の各文の文字数が300文字以内 クラス数:2種類以上 各クラスのデータ数:6個以上 |
type |
string |
任意 |
以下のどちらかを指定可(省略時:default) default - 通常文 kuzure - SNSなどの崩れた文 |
リクエストサンプル(cURL)
$ curl -H "Content-Type: multipart/form-data" -H "Authorization:Bearer [Access Token]" -X POST -F "dataset=@input.csv;type=text/csv" -F "type=default" [API Base URL]/nlp/v1/classifier/models
csvファイルサンプル
Check,契約している保険の内容を確認したいです。 Check,契約している保険の内容確認を依頼したい。 Check,契約中の保険内容見せてもらえる? Check,保険の加入時期って確認できますか。 Check,加入者の名義って誰になっていますか? Check,"契約中の電話番号が""090-1234-5678""なんですが、契約内容を調べてもらえますか" Check,"契約状況を教えて下さい。 契約番号はN00000000です。" Estimate,保険の見積もりお願いしていいですか。 Estimate,保険の見積もりをしてほしいです。 Estimate,結婚したので、保険を見積もってほしい。 Estimate,保険の見積をお願いします。 Estimate,保険を検討しているので、金額を比較したい。 Estimate,保険でいくらくらいかかるか知りたい。 Estimate,クレジットカードで払いたいのですが、詳細な見積もりをしてもらえますか?
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
result |
object |
|
status |
integer |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
モデル情報オブジェクト
キー名 | データ型 | 説明 |
---|---|---|
model_id |
string |
モデルのID |
レスポンスサンプル
{ "result": { "model_id": "bdcee0bc-0f7d-4ee9-b195-a8c7da920cc2" }, "status": 0, "message": "OK" }
モデル分類API
リクエスト
HTTPエンドポイント
POST [API Base URL]/nlp/v1/classifier/models/<model_id>/classify
リクエストヘッダ
キー名 | 説明 |
---|---|
Content-Type |
application/json;charset=UTF-8 |
Authorization |
Bearer [Access Token] |
リクエストボディ
キー名 | データ型 | 必須 | 説明 |
---|---|---|---|
text |
string |
必須 |
解析対象のテキスト |
リクエストサンプル(cURL)
$ curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization:Bearer [Access Token]" -X POST -d '{"text":"契約してる保険の内容を確認したい"}' [API Base URL]/nlp/v1/classifier/models/bdcee0bc-0f7d-4ee9-b195-a8c7da920cc2/classify
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
result |
array(object) |
分類結果オブジェクトの配列。scoreにおいて降順 |
status |
integer |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
分類結果オブジェクト
キー名 | データ型 | 説明 |
---|---|---|
class |
string |
分類結果のクラス名 |
score |
float |
分類結果の確信度(0.0~1.0) |
レスポンスサンプル
{ "result": [ { "class": "Check", "score": 0.85 }, ... { "class": "Contract", "score": 0 } ], "status": 0, "message": "OK" }
モデル一覧API
リクエスト
HTTPエンドポイント
GET [API Base URL]/nlp/v1/classifier/models
リクエストヘッダ
キー名 | 説明 |
---|---|
Authorization |
Bearer [Access Token] |
リクエストサンプル(cURL)
$ curl -H "Authorization:Bearer [Access Token]" -X GET [API Base URL]/nlp/v1/classifier/models
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
result |
array(object) |
※各アカウントにつき保存できるモデル数は10個までとなります |
status |
integer |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
モデル一覧情報オブジェクト
キー名 | データ型 | 説明 |
---|---|---|
model_id |
string |
モデルのID |
model_status |
string |
モデルの学習状況。下記のいずれかの値を取る。 processing /completed /failed |
created_at |
string |
モデルが生成された日時 |
レスポンスサンプル
{ "result": [ { "model_id": "31cbb5d6-6aa7-4ec1-a2af-d8cd9c14a92d", "model_status": "completed", "created_at": "2020-04-01T20:17:47+09:00" }, ... { "model_id": "bdcee0bc-0f7d-4ee9-b195-a8c7da920cc2", "model_status": "completed", "created_at": "2020-04-01T19:14:03+09:00" } ], "status": 0, "message": "OK" }
モデル確認API
リクエスト
HTTPエンドポイント
GET [API Base URL]/nlp/v1/classifier/models/<model_id>
リクエストヘッダ
キー名 | 説明 |
---|---|
Authorization |
Bearer [Access Token] |
リクエストサンプル(cURL)
$ curl -H "Authorization:Bearer [Access Token]" -X GET [API Base URL]/nlp/v1/classifier/models/bdcee0bc-0f7d-4ee9-b195-a8c7da920cc2
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
result |
object |
|
status |
integer |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
モデル学習状況オブジェクト
キー名 | データ型 | 説明 |
---|---|---|
model_status |
string |
モデルの学習状況。下記のいずれかの値を取る。 processing /completed /failed |
report |
object |
学習データにおける評価レポートオブジェクト。model_statusがcompletedである場合に出力する。 |
レスポンスサンプル
{ "result": { "model_status": "completed", "report": { "Check": { "precision": 0.8, "recall": 0.8, "f1-score": 0.8, "support": 20 }, ... "Contract": { "precision": 0.62, "recall": 0.75, "f1-score": 0.68, "support": 20 }, "accuracy": 0.77, "macro avg": { "precision": 0.78, "recall": 0.77, "f1-score": 0.76, "support": 180 }, "weighted avg": { "precision": 0.78, "recall": 0.77, "f1-score": 0.76, "support": 180 } } }, "status": 0, "message": "OK" }
モデル削除API
リクエスト
HTTPエンドポイント
DELETE [API Base URL]/nlp/v1/classifier/models/<model_id>
リクエストヘッダ
キー名 | 説明 |
---|---|
Authorization |
Bearer [Access Token] |
リクエストサンプル(cURL)
$ curl -H "Authorization:Bearer [Access Token]" -X DELETE [API Base URL]/nlp/v1/classifier/models/bdcee0bc-0f7d-4ee9-b195-a8c7da920cc2
レスポンス
キー名 | データ型 | 説明 |
---|---|---|
status |
integer |
ステータスコード 0:OK, >0:エラー |
message |
string |
エラーメッセージ |
レスポンスサンプル
{ "status": 0, "message": "OK" }
エラーコード一覧
構文解析API等で出力される代表的なエラーコードの一覧について以下に示します。
エラーコード | 説明 | 対処 |
---|---|---|
99993 |
バージョン不正 |
リクエストパスを再確認してください。 |
99995 |
予め設定した利用量制限に到達した(for Enterpriseユーザのみ) |
アカウントページより、利用量制限を変更してください。 |
99996 |
利用量制限に到達した(for Developersユーザのみ) |
24時間内に利用できる回数制限に達しました。時間をおいて再度ご利用ください |
99997 |
短時間に大量のリクエストを行ったため一時的にリクエストを遮断した |
ごく短時間に大量のアクセスを検知したため一時的にリクエストを遮断しました。リクエスト頻度を調整して再度お試しください。 |
99998 |
認証エラー |
認証情報が不正です。アクセストークンの取得に利用した認証情報を再度ご確認ください。 |
6103 |
Parse API でJSON形式不正 |
Parse API で、入力のJSONの形式が不正の場合に返却されます。リクエストの内容を再度お確かめください。 |