POST NLU/Parse

This end point will be used to process user inputs. It will extract intents and entities if exists.

Request Information

URI Parameters

None.

Body Parameters

you need to send a user query to get Jetlink NLU API processing results

Name	Description	Type	Additional information
Text	User phrase should be send on this property.	string	None.
SessionId	(Optional) Unique SessionId value for each conversation.	string	None.
JetBotMainId	(Optional) Unique JetBotMainId value for each conversation.	string	None.
Language	(Optional) Language of the phrase. "en", "tr" are supported for now.	string	None.
TimeZone	(Optional) Sometimes you need to send timezone of the user.	string	None.
Location	(Optional) If you need to to location specific result, you can send location info by this property.	Location	None.
FromJetlinkUserId	(Optional) If you need to send jetlnk user id for the messaging user, you can set this parameter.	string	None.
TestMode	(Optional) If you need to test jetlnk with passive intents, you can set this parameter.	boolean	None.
IsJsonData	(Optional) If you need send to json data, you can set this parameter.	boolean	None.
PlatformType	(Optional) If you need filter intents and responses by platform, you can set this parameter.	DataSource	None.
ChannelId	(Optional) If you need filter intents and responses by channel, you can set this parameter. If this parameter is full, the platform parameter is not considered.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Text": "sample string 1",
  "SessionId": "sample string 2",
  "JetBotMainId": "sample string 3",
  "Language": "sample string 4",
  "TimeZone": "sample string 5",
  "Location": {
    "Latitude": "sample string 1",
    "Longitude": "sample string 2"
  },
  "FromJetlinkUserId": "sample string 6",
  "TestMode": true,
  "IsJsonData": true,
  "PlatformType": 0,
  "ChannelId": "sample string 9"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Query'.

Response Information

Resource Description

QueryResponse

Name	Description	Type	Additional information
Id	Returned process unique id	string	None.
Timestamp	Returned process time. (in unix timestamp format)	integer	None.
Language	Language info of user phrase send when calling API.	string	None.
SessionId	SessionId of user conversation send when calling API. If this is not sent, Jetlink NLU Engine creates a unique session id for each API call.	string	None.
Result	Returned data from Jetlink NLU Engine.	QueryResult	None.
Status	Returned status of process	Status	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "Timestamp": 2,
  "Language": "sample string 3",
  "SessionId": "sample string 4",
  "Result": {
    "ResolvedQuery": "sample string 1",
    "IntentId": "sample string 2",
    "IntentName": "sample string 3",
    "IntentType": 1,
    "MatchedUserSaysValue": "sample string 4",
    "Action": "sample string 5",
    "Parameters": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "TextResponse": "sample string 6",
    "Responses": [
      {},
      {}
    ],
    "Text2Speeches": [
      {
        "Texts": [
          "sample string 1",
          "sample string 2"
        ],
        "ShowDelaySeconds": 1.1,
        "ChannelId": "sample string 2"
      },
      {
        "Texts": [
          "sample string 1",
          "sample string 2"
        ],
        "ShowDelaySeconds": 1.1,
        "ChannelId": "sample string 2"
      }
    ],
    "Confidence": 7.1,
    "HumanTakeOver": true,
    "SendContactInfoCollector": true,
    "SendContactInfoCollectorDelayTime": 10.1,
    "HumanTakeOverDelayTime": 11.1,
    "IsInBusinessHour": true,
    "OnlineMessage": "sample string 13",
    "OfflineMessage": "sample string 14",
    "DebugData": [
      {
        "MatchType": "sample string 1",
        "IntentId": "sample string 2",
        "IntentName": "sample string 3",
        "MatchedUserSay": "sample string 4",
        "Confidence": 5.1,
        "Selected": true
      },
      {
        "MatchType": "sample string 1",
        "IntentId": "sample string 2",
        "IntentName": "sample string 3",
        "MatchedUserSay": "sample string 4",
        "Confidence": 5.1,
        "Selected": true
      }
    ]
  },
  "Status": {
    "Code": 1,
    "ErrorType": "sample string 2",
    "ErrorId": "sample string 3",
    "ErrorDescription": "sample string 4"
  }
}