Connectors Reference

LUIS

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

 

Actions:

Name

Summary

GetPredictions (string app-id, string q, [Optional]string desiredIntent, [internal]boolean verbose)

Get prediction

ListApps ()

List Apps

ListIntents (string app-id)

List Intents

ListEntities (string app-id, [Optional]string versionId)

List Entities

GetTopScoringMatchingEntity (string app-id, string desiredEntity, [Optional]string versionId, string luisPredictionObject)

Get entity by type

ListVersions (string app-id)

List Versions

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

App

 

Entity

 

EntityMatchInfo

 

GetTopScoringMatchingEntityResponse

 

Intent

 

Intents

 

LuisPredictResponseEntity

 

LuisPredictResponseEntityMinusType

 

PredictResponse

 

Version

 

 

Actions:

GetPredictions

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, [internal]boolean verbose)

 

Parameters:

Name

Type

Summary

Required

Related Action

app-id

string

(App Id)

Id of the trained application.

True

ListApps

q

string

(Utterance Text)

String to predict

True

desiredIntent

string

(Desired Intent)

Desired top scoring intent

False

ListIntents

verbose

boolean

 

 

True

 

Returns:

          Type:PredictResponse

 

ListApps

Summary: List Apps

Description: List Apps In Your Subscription

 

Syntax:

LUIS.ListApps ()

 

Returns:

          Type:array of (App)

 

ListIntents

Summary: List Intents

Description: List Intents For Selected App

 

Syntax:

LUIS.ListIntents (string app-id)

 

Parameters:

Name

Type

Summary

Required

Related Action

app-id

string

(App Id)

Id of the trained application.

True

ListApps

 

Returns:

          Type:Intents

 

ListEntities

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

ListApps

versionId

string

(Task Version Id)

The Task Version Id. The value 0.1 will be used by default.

False

ListVersions

 

Returns:

          Type:array of (Entity)

 

GetTopScoringMatchingEntity

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

ListApps

desiredEntity

string

(Desired Entity)

The Desired Entity.

True

ListEntities

versionId

string

(Task Version Id)

The Task Version Id. The value 0.1 will be used by default.

False

ListVersions

luisPredictionObject

string

(LUIS Prediction)

Output from 'Get Predictions' action

True

 

Returns:

          Type:GetTopScoringMatchingEntityResponse

 

ListVersions

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

ListApps

 

Returns:

          Type:array of (Version)

 


 

App

Summary:

Description:

 

          Properties:

Name

Type

Summary

ID

string

App ID

LUIS app id.

Name

string

App name

Name of the LUIS app.


 

Entity

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.


 

EntityMatchInfo

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.


 

GetTopScoringMatchingEntityResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

entity

LuisPredictResponseEntityMinusType

 

 

entityMatchInfo

EntityMatchInfo

 

 


 

Intent

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.

type

string

Intent Type

Type of the intent model.


 

Intents

Summary:

Description:

 

          Properties:

Name

Type

Summary

Result

array of (Intent)

 

 


 

LuisPredictResponseEntity

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.


 

LuisPredictResponseEntityMinusType

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.


 

PredictResponse

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

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.

 

TopScoringIntent

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.

 

IntentsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

intent

string

Intent Name

Name of the intent model.

score

number(float)

Intent Score

Percent confidence of prediction.

 


 

Version

Summary:

Description:

 

          Properties:

Name

Type

Summary

version

string

Task Version Id

The Task Version Id.