A3RT

Internal user

  1. TOP
  2. PRODUCT
  3. Talk API

Talk API

TalkAPI

Talk APIはChatbotを作成するためのAPIです。 Recurrent Neural Network(LSTM)を用いた入力文からの応答文生成による日常会話応答機能を提供します。 Talk APIを活用したChatbotによって様々なアプリケーション上でユーザとの対話を自動化し、 どのようなタイミングにおいても即座にユーザからの問いかけに対して応答することができます。

DETAIL

[Small Talk API]

完全自動の日常会話を可能にするAPIです。 例えばあなたの運用しているWebサイトでAPIを呼び出しサイト上でユーザとの会話を可能にします。 さらにユーザとの会話を学習していくことでより賢く・より自然な会話を実現します。

NOTES

他人の名称・メールアドレス・住所・電話番号など個人を特定しうる情報はアップロードしないでください。

REFERENCE

入力されたテキストに対する雑談応答を返却します。

エンドポイント

URL：
https://api.a3rt.recruit-tech.co.jp/talk/v1/smalltalk
メソッド：
POST

リクエストパラメータ

No. パラメータ名 説明 値サンプル 制約 必須
1 apikey APIキーを指定します AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA 半角英数字 ○
2 callback コールバックを指定します jQuery18308453692126555485_1471946187158 レスポンス ContentType は
callback 未指定時：application/json
callback 指定時：application/javascript		 -
3 query 入力テキストを指定します おはよう UTF-8 ○

レスポンスフィールド

No. フィールド名 説明 値サンプル 型 返却条件 複数項目
1 status 処理ステータス 0 int 常に返却 -
2 message メッセージ ok string 常に返却 -
3 results 結果 - list 正常時に返却 -
perplexity 予測性能 1.3358218026477 float 正常時に返却 -
reply 応答テキスト おはようございます string 正常時に返却 -

ステータスコード / メッセージ

No. status HTTP
status		 message 返却条件
1 0 200 ok 正常応答
2 1000 400 apikey is null APIキー未指定
3 1001 400 apikey not found APIキーが見つからない
4 1002 400 deleted account 退会済み
5 1003 400 temporary account アカウント未承認
6 1010 400 server not found サーバが見つからない
7 1011 400 server parameter error サーバ設定エラー
8 1030 403 access deny アクセス拒否
9 1400 400 bad request リクエストパラメータが不正
10 1404 404 not found エンドポイントが不正
11 1405 405 method not allowed リクエストメソッドが不正
12 1413 413 request entity too long リクエストのボディサイズが制限値を超過
13 1500 500 internal server error サーバ処理中に想定外のエラーが発生
14 2000 200 empty reply 応答テキストが空

制限事項

HTTP POST リクエストのボディサイズに関する制限事項

ボディサイズの上限値は 2048 bytes です。

ブラウザによるファイルのアップロードは、今後対応していく予定です

SAMPLE REQUEST

サンプルリクエスト / レスポンス

1）正常時（callback パラメータ未指定）

リクエスト curl -X POST https://api.a3rt.recruit-tech.co.jp/talk/v1/smalltalk \
-F "apikey=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" \
-F "query=おはよう"
レスポンス 

{
	status: 200,
	message: "ok",
	results: [{
		perplexity: 2.3688167429546714,
		reply: "おはようございます"
	}],
}

2）正常時（callback パラメータ指定）

リクエスト curl -X POST https://api.a3rt.recruit-tech.co.jp/talk/v1/smalltalk \
-F "apikey=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" \
-F "callback=jQuery18308453692126555485_1471946187158" \
-F "query=おはよう"
レスポンス 

jQuery18308453692126555485_1471946187158({
	status: 200,
	message: "ok",
	results: [{
		perplexity: 2.3688167429546714,
		reply: "おはようございます"
	}],
})

3）異常時（callback パラメータ未指定）

リクエスト curl -X POST https://api.a3rt.recruit-tech.co.jp/talk/v1/smalltalk \
-F "apikey=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
レスポンス 

{
	status: 1400,
	message: "bad request",
}

4）異常時（callback パラメータ指定）

リクエスト curl -X POST https://api.a3rt.recruit-tech.co.jp/talk/v1/smalltalk \
-F "apikey=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" \
-F "callback=jQuery18308453692126555485_1471946187158"
レスポンス 

jQuery18308453692126555485_1471946187158({
	status: 1400,
	message: "bad request",
})