SimSimi database consists of simple "Request - Response" set.
When you request "Hi", SimSimi API send "Response" by similarity with request sentence.
Conversation API enables you to get SimSimi's response data. Use the Conversation REST API
Request URL:
Key Type | Request URL |
Trial-key | http://sandbox.api.simsimi.com/request.p |
Signup for Trial key |
Paid-key | http://api.simsimi.com/request.p |
|
Request parameters:
Parameter |
Value |
Required |
Default |
Description |
key |
String |
Y |
|
Your key value |
text |
String |
Y |
|
Query message |
lc |
String |
Y |
|
Language code(List) |
ft |
Double(0.0 ~ 1.0) |
|
0.0 |
1.0 : 'filter out bad words' Classification - Probablistic, Neural Network (DBSC) for Korean |
Sample request URL:
Key Type | Sample request URL (HTTP Methods: GET) |
Trial-key | http://sandbox.api.simsimi.com/request.p?key=your_trial_key&lc=en&ft=1.0&text=hi |
Paid-key | http://api.simsimi.com/request.p?key=your_paid_key&lc=en&ft=1.0&text=hi |
Response elements:
Element |
Value |
Description |
result |
Integer |
100-OK. 400-Bad Request. 401-Unauthorized. 404-Not found.500-Server Error. |
id |
Integer |
Response id. (you can get only if returning result is 100) |
response |
String |
Response message(you can get only if returning result is 100) |
msg |
String |
Result msg(Description of result code) |
Sample response:
{
"result": 100,
"response": "Who are you?!",
"id": 13185569,
"msg": "OK."
}
1. 3rd Party Teach Function Teach the response to a particular requset.
2. Keyword Set responses to a request included in a specific word .
3. Filter Set filtering words.
This feature works in Conversation API.
Teach API (HTTP Methods: POST)
Teach the response to a particular request.
If a request to API matches a request the 3rd party taught exactly, the set response is returned.
Request URL:
Key Type | Request URL |
Trial-key | http://sandbox.api.simsimi.com/teach |
Signup for Trial key |
Paid-key | http://api.simsimi.com/teach |
|
Request parameters:
Parameter |
Value |
Required |
Default |
Description |
key |
String |
Y |
|
Your key value |
req |
String |
Y |
|
Question message |
res |
String |
Y |
|
Answer message |
lc |
String |
|
en |
Language code(List) |
Response elements:
Element |
Value |
Description |
result |
Integer |
100-OK. 400-Bad Request. 401-Unauthorized. 404-Not found.500-Server Error. |
msg |
String |
Result msg(Description of result code) |
Sample response:
{
"result": 100,
"msg": "OK."
}
Keyword API (HTTP Methods: POST)
Set responses to a request included in a specific word.
If a request to API includes specific word, a response the 3rd party taught is returned. (it is ahead of the others)
Request URL:
Key Type | Request URL |
Trial-key | http://sandbox.api.simsimi.com/keyword |
Signup for Trial key |
Paid-key | http://api.simsimi.com/keyword |
|
Request parameters:
Parameter |
Value |
Required |
Default |
Description |
key |
String |
Y |
|
Your key value |
req |
String |
Y |
|
Keyword |
res |
String |
Y |
|
Answer message |
lc |
String |
|
en |
Language code(List) |
Response elements:
Element |
Value |
Description |
result |
Integer |
100-OK. 400-Bad Request. 401-Unauthorized. 404-Not found.500-Server Error. |
msg |
String |
Result msg(Description of result code) |
Sample response:
{
"result": 100,
"msg": "OK."
}
Filter API (HTTP Methods: POST)
Set filtering words. If a request to API includes filtering word, a response exclusive of filtered sentence is returned.
Request URL:
Key Type | Request URL |
Trial-key | http://sandbox.api.simsimi.com/filter |
Signup for Trial key |
Paid-key | http://api.simsimi.com/filter |
|
Request parameters:
Parameter |
Value |
Required |
Default |
Description |
key |
String |
Y |
|
Your key value |
word |
String |
Y |
|
Phrases to be filtered |
lc |
String |
|
en |
Language code(List) |
Response elements:
Element |
Value |
Description |
result |
Integer |
100-OK. 400-Bad Request. 401-Unauthorized. 404-Not found.500-Server Error. |
msg |
String |
Result msg(Description of result code) |
Sample response:
{
"result": 100,
"msg": "OK."
}