Azure cognitive services language understanding intelligent service (LUIS) lets you understand language contextually, so your apps communicate with people in the way they speak.
Status: Preview |
Tier: Standard |
Version: 1.0.0 |
Name |
Summary |
Get prediction |
|
List Apps |
|
List Intents |
|
List Entities |
|
Get entity by type |
|
List Versions |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get prediction
Description: Given some input text, this operations returns a prediction based on a pre-trained model. The prediction object returned can also be used as input for other LUIS actions.
Syntax:
LUIS.GetPredictions (string app-id, string q, [Optional]string desiredIntent, [Optional]string versionId, [internal]boolean verbose)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
app-id |
string (App Id) |
Id of the trained application. |
True |
|
q |
string (Utterance Text) |
String to predict |
True |
|
desiredIntent |
string (Desired Intent) |
Desired top scoring intent |
False |
|
versionId |
string (App version) |
The version name. The value 0.1 will be used by default. |
False |
|
verbose |
boolean
|
|
True |
Returns:
Type:PredictResponse
Summary: List Apps
Description: List Apps In Your Subscription
Syntax:
LUIS.ListApps ()
Returns:
Type:array of (App)
Summary: List Intents
Description: List Intents For Selected App
Syntax:
LUIS.ListIntents (string app-id, [Optional]string versionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
app-id |
string (App Id) |
Id of the trained application. |
True |
|
versionId |
string (App version) |
The version name. The value 0.1 will be used by default. |
False |
Returns:
Type:array of (Intent)
Summary: List Entities
Description: List Entities For Selected App
Syntax:
LUIS.ListEntities (string app-id, [Optional]string versionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
app-id |
string (App Id) |
Id of the trained application. |
True |
|
versionId |
string (App version) |
The version name. The value 0.1 will be used by default. |
False |
Returns:
Type:array of (Entity)
Summary: Get entity by type
Description: For a given entity type, the operation returns the best matching entity model from the LUIS prediction object.
Syntax:
LUIS.GetTopScoringMatchingEntity (string app-id, string desiredEntity, [Optional]string versionId, string luisPredictionObject)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
app-id |
string (App Id) |
Id of the trained application |
True |
|
desiredEntity |
string (Desired Entity) |
The Desired Entity. |
True |
|
versionId |
string (App version) |
The version name. The value 0.1 will be used by default. |
False |
|
luisPredictionObject |
string (LUIS Prediction) |
Output from 'Get Predictions' action |
True |
Returns:
Type:GetTopScoringMatchingEntityResponse
Summary: List Versions
Description: List Application Versions For Selected App
Syntax:
LUIS.ListVersions (string app-id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
app-id |
string (App Id) |
Id of the trained application. |
True |
Returns:
Type:array of (Version)
Summary:
Description:
Properties:
Name |
Type |
Summary |
ID |
string App ID |
LUIS app id. |
Name |
string App name |
Name of the LUIS app. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Entity Id |
Id of the LUIS entity model. |
name |
string Entity Name |
Name of the entity model. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
desiredEntity |
string Desired Entity |
Desired entity specified as input, if any. |
isEntityMatch |
boolean Is Entity Match |
True if the specific entity was found. |
entityMatchCount |
integer Entity Match Count |
Number of entities that match the desired entity type. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
entity |
LuisPredictResponseEntityMinusType
|
|
entityMatchInfo |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Intent Id |
Id of the LUIS intent model. |
name |
string Intent Name |
Name of the intent model. |
readableType |
string Intent Type |
Type of the intent model. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
entity |
string Entity Value |
Value of the corresponding entity type. |
type |
string Entity Type |
Name of the entity model. |
startIndex |
integer(int32) Start Index |
Start Index |
endIndex |
integer(int32) End Index |
End Index |
score |
number(float) Entity Score |
Percent confidence of prediction. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
entity |
string Entity Value |
Value of the corresponding entity type. |
score |
number(float) Entity Score |
Percent confidence of prediction. |
resolution |
string Entity Resolution |
The resolution of this entity. Only applies to built in entities. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
luisPrediciton |
string LUIS Prediction |
Used as input for other other LUIS actions. |
isDesiredIntent |
boolean Is Desired Intent |
True if the top scoring intent matches the desired intent. |
desiredIntent |
string Desired Intent |
Desired intent specified as input, if any. |
query |
string Utterance Text |
String that the prediction is based off. |
topScoringIntent |
Top Scoring Intent |
Top scoring intent model. |
intents |
array of (IntentsItem) Intents Array |
List of all predicted intents. |
entities |
array of (LuisPredictResponseEntity) Entities Array |
List of all predicted entities. |
Summary: Top Scoring Intent
Description: Top scoring intent model.
Properties:
Name |
Type |
Summary |
intent |
string Name |
Name of the intent model. |
score |
number(float) Score |
Percent confidence of prediction. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
intent |
string Intent Name |
Name of the intent model. |
score |
number(float) Intent Score |
Percent confidence of prediction. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
version |
string App version name |
App version |