version 1.03
API一覧
※盛Q = あるQ&Aの質問に対して、別の表現の質問のことです。
例
- Q「お花の寿命を延ばすには？」
- A「こまめに手入れして下さい」
のQ&Aを登録したとして、このQ&Aの盛Qとして、
- 盛Q「お花を長持ちさせるには？」 等を登録します。
- ※以下、各APIの{API_URL}には、環境毎のAPI URLを設定して下さい。（API利用希望者様にお知らせ致しますので、お問合せ下さい。）
- ※以下、パラメータのサイズは、stringの場合は文字数、それ以外の場合はバイト数とします。
Q&A 登録 API｜QA-001
Q&A、盛Qの登録や更新を行うAPI
入力
| アクセスURI | {API_URL}/retrieve |
|---|
| メソッド | POST |
|---|
パラメーター
| Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| API_KEY | string | 255 | ○ | 与えられたAPIキー |
| question | string | 10000 | ○ | 質問 |
| answer | string | 10000 | ○ | 回答 |
| parent_id | int | 10 | | 盛Qの場合の親のID |
| id | int | 10 | | 更新する場合のQAのID |
| label | string | 10000 | | 付与ラベルを半角カンマ区切り |
出力（返却データ：JSON形式）
| JSON Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| status | string | 255 | ○ | 結果のステータス。success またはerror |
| id | string | 255 | ○ | 追加・更新されたQAのID |
Q&A 検索 API｜QA-002
queryテキストから、近いQuestionを検索し、上位5件を返却するAPI
入力
| アクセスURI | {API_URL}/retrieve |
|---|
| メソッド | GET |
|---|
パラメーター
| Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| API_KEY | string | 255 | ○ | 与えられたAPIキー |
| query | string | 10000 | ○ | 検索するクエリ |
| label | string | 10000 | | 検索するラベルを半角カンマ区切り（OR検索) |
出力（返却データ：JSON形式）
| JSON Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| status | string | 255 | ○ | 結果のステータス。success またはerror |
| result | list | | ○ | id,question,answer,parent_id,scoreの結果のリスト |
Q&A 削除 API｜QA-003
特定IDのQ&Aを削除するAPI
入力
| アクセスURI | {API_URL}/delete |
|---|
| メソッド | POST |
|---|
パラメーター
| Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| API_KEY | string | 255 | ○ | 与えられたAPIキー |
| id | string | 255 | ○ | 削除するQAのID |
出力（返却データ：JSON形式）
| JSON Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| status | string | 255 | ○ | 結果のステータス。success またはerror |
全Q&A 取得 API｜QA-004
登録済みのQ&Aを全て取得するAPI
入力
| アクセスURI | {API_URL}/get_all_qa |
|---|
| メソッド | GET |
|---|
パラメーター
| Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| API_KEY | string | 255 | ○ | 与えられたAPIキー |
出力（返却データ：JSON形式）
| JSON Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| status | string | 255 | ○ | 結果のステータス。success またはerror |
| result | string | 255 | ○ | id,question,answer,parent_id の結果のリスト |
盛Q 削除 API｜QA-005
特定IDのQ&Aの盛Qを全て削除するAPI
入力
| アクセスURI | {API_URL}/delete_children |
|---|
| メソッド | POST |
|---|
パラメーター
| Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| API_KEY | string | 255 | ○ | 与えられたAPIキー |
| id | string | 255 | ○ | 盛Qを削除する親のQAのID |
出力（返却データ：JSON形式）
| JSON Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| status | string | 255 | ○ | 結果のステータス。success またはerror |
コミット API｜QA-006
Q&Aの登録後やシノニム登録後、学習を行うためのAPI
入力
| アクセスURI | {API_URL}/commit |
|---|
| メソッド | POST |
|---|
パラメーター
| Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| API_KEY | string | 255 | ○ | 与えられたAPIキー |
出力（返却データ：JSON形式）
| JSON Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| status | string | 255 | ○ | 結果のステータス。success またはerror |
同義語 登録 API｜SY-001
同義語の登録や更新を行うAPI
入力
| アクセスURI | {API_URL}/synonym |
|---|
| メソッド | POST |
|---|
パラメーター
| Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| API_KEY | string | 255 | ○ | 与えられたAPIキー |
| original | string | 255 | ○ | オリジナルの語 |
| synonym | string | 255 | ○ | オリジナルの同義語となる語 |
出力（返却データ：JSON形式）
| JSON Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| status | string | 255 | ○ | 結果のステータス。success またはerror |
同義語 取得 API｜SY-002
同義語の一覧を取得するAPI
入力
| アクセスURI | {API_URL}/get_all_synonyms |
|---|
| メソッド | GET |
|---|
パラメーター
| Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| API_KEY | string | 255 | ○ | 与えられたAPIキー |
出力（返却データ：JSON形式）
| JSON Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| status | string | 255 | ○ | 結果のステータス。success またはerror |
| data | list | | ○ | synonym,originalのhashのリスト |
同義語 削除 API｜SY-003
同義語を削除するAPI
入力
| アクセスURI | {API_URL}/delete_synonym |
|---|
| メソッド | POST |
|---|
パラメーター
| Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| API_KEY | string | 255 | ○ | 与えられたAPIキー |
| original | string | 255 | ○ | オリジナルの語 |
| synonym | string | 255 | ○ | オリジナルの同義語となる語 |
出力（返却データ：JSON形式）
| JSON Key | 型 | サイズ | 必須 | 値の説明 |
|---|
| status | string | 255 | ○ | 結果のステータス。success またはerror |
