API仕様|Neurox チャットボット

version 1.03

API一覧

API No.API名機能概要
QA-001Q&A 登録 APIQ&A、盛Q(※)の登録や更新を行うAPI
QA-002Q&A 検索 APIqueryテキストから、近いQuestionを検索し、上位5件を返却するAPI
QA-003Q&A 削除 API特定IDのQ&Aを削除するAPI
QA-004全Q&A 取得 API登録済みのQ&Aを全て取得するAPI
QA-005盛Q(※) 削除 API特定IDのQ&Aの盛Qを全て削除するAPI
QA-006コミット APIQ&Aの登録後やシノニム登録後、学習を行うためのAPI
SY-001同義語 登録 API同義語の登録や更新を行うAPI
SY-002同義語 取得 API同義語の一覧を取得するAPI
SY-003同義語 削除 API同義語を削除する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_KEYstring255与えられたAPIキー
questionstring10000質問
answerstring10000回答
parent_idint10盛Qの場合の親のID
idint10更新する場合のQAのID
labelstring10000付与ラベルを半角カンマ区切り

出力(返却データ:JSON形式)

JSON Keyサイズ必須値の説明
statusstring255結果のステータス。success またはerror
idstring255追加・更新されたQAのID

Q&A 検索 API|QA-002

queryテキストから、近いQuestionを検索し、上位5件を返却するAPI

入力

アクセスURI{API_URL}/retrieve
メソッドGET

パラメーター

Keyサイズ必須値の説明
API_KEYstring255与えられたAPIキー
querystring10000検索するクエリ
labelstring10000検索するラベルを半角カンマ区切り(OR検索)

出力(返却データ:JSON形式)

JSON Keyサイズ必須値の説明
statusstring255結果のステータス。success またはerror
resultlistid,question,answer,parent_id,scoreの結果のリスト

Q&A 削除 API|QA-003

特定IDのQ&Aを削除するAPI

入力

アクセスURI{API_URL}/delete
メソッドPOST

パラメーター

Keyサイズ必須値の説明
API_KEYstring255与えられたAPIキー
idstring255削除するQAのID

出力(返却データ:JSON形式)

JSON Keyサイズ必須値の説明
statusstring255結果のステータス。success またはerror

全Q&A 取得 API|QA-004

登録済みのQ&Aを全て取得するAPI

入力

アクセスURI{API_URL}/get_all_qa
メソッドGET

パラメーター

Keyサイズ必須値の説明
API_KEYstring255与えられたAPIキー

出力(返却データ:JSON形式)

JSON Keyサイズ必須値の説明
statusstring255結果のステータス。success またはerror
resultstring255id,question,answer,parent_id の結果のリスト

盛Q 削除 API|QA-005

特定IDのQ&Aの盛Qを全て削除するAPI

入力

アクセスURI{API_URL}/delete_children
メソッドPOST

パラメーター

Keyサイズ必須値の説明
API_KEYstring255与えられたAPIキー
idstring255盛Qを削除する親のQAのID

出力(返却データ:JSON形式)

JSON Keyサイズ必須値の説明
statusstring255結果のステータス。success またはerror

コミット API|QA-006

Q&Aの登録後やシノニム登録後、学習を行うためのAPI

入力

アクセスURI{API_URL}/commit
メソッドPOST

パラメーター

Keyサイズ必須値の説明
API_KEYstring255与えられたAPIキー

出力(返却データ:JSON形式)

JSON Keyサイズ必須値の説明
statusstring255結果のステータス。success またはerror

同義語 登録 API|SY-001

同義語の登録や更新を行うAPI

入力

アクセスURI{API_URL}/synonym
メソッドPOST

パラメーター

Keyサイズ必須値の説明
API_KEYstring255与えられたAPIキー
originalstring255オリジナルの語
synonymstring255オリジナルの同義語となる語

出力(返却データ:JSON形式)

JSON Keyサイズ必須値の説明
statusstring255結果のステータス。success またはerror

同義語 取得 API|SY-002

同義語の一覧を取得するAPI

入力

アクセスURI{API_URL}/get_all_synonyms
メソッドGET

パラメーター

Keyサイズ必須値の説明
API_KEYstring255与えられたAPIキー

出力(返却データ:JSON形式)

JSON Keyサイズ必須値の説明
statusstring255結果のステータス。success またはerror
datalistsynonym,originalのhashのリスト

同義語 削除 API|SY-003

同義語を削除するAPI

入力

アクセスURI{API_URL}/delete_synonym
メソッドPOST

パラメーター

Keyサイズ必須値の説明
API_KEYstring255与えられたAPIキー
originalstring255オリジナルの語
synonymstring255オリジナルの同義語となる語

出力(返却データ:JSON形式)

JSON Keyサイズ必須値の説明
statusstring255結果のステータス。success またはerror