@datafire/azure_cognitiveservices_luis_programmatic v4.0.0

@datafire/azure_cognitiveservices_luis_programmatic

Client library for LUIS Programmatic

Installation and Usage

npm install --save @datafire/azure_cognitiveservices_luis_programmatic

let azure_cognitiveservices_luis_programmatic = require('@datafire/azure_cognitiveservices_luis_programmatic').create({
  apiKeyHeader: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

Apps_List

Lists all of the user applications.

azure_cognitiveservices_luis_programmatic.Apps_List({}, context)

Input

• input object
  • skip integer: The number of entries to skip. Default value is 0.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output ApplicationsInfoList

Apps_Add

Creates a new LUIS app.

azure_cognitiveservices_luis_programmatic.Apps_Add({
  "applicationCreateObject": {
    "culture": "",
    "name": ""
  }
}, context)

Input

• input object
  • applicationCreateObject required ApplicationCreateObject

Output

• output GuidResponse

Apps_ListCortanaEndpoints

Gets the endpoint URLs for the prebuilt Cortana applications.

azure_cognitiveservices_luis_programmatic.Apps_ListCortanaEndpoints(null, context)

Input

This action has no parameters

Output

• output PersonalAssistantsResponse

Apps_ListSupportedCultures

Gets the supported application cultures.

azure_cognitiveservices_luis_programmatic.Apps_ListSupportedCultures(null, context)

Input

This action has no parameters

Output

• output AvailableCultures

Apps_ListAvailableCustomPrebuiltDomains

Gets all the available custom prebuilt domains for all cultures.

azure_cognitiveservices_luis_programmatic.Apps_ListAvailableCustomPrebuiltDomains(null, context)

Input

This action has no parameters

Output

• output PrebuiltDomainsList

Apps_AddCustomPrebuiltDomain

Adds a prebuilt domain along with its models as a new application.

azure_cognitiveservices_luis_programmatic.Apps_AddCustomPrebuiltDomain({
  "prebuiltDomainCreateObject": {}
}, context)

Input

• input object
  • prebuiltDomainCreateObject required PrebuiltDomainCreateObject

Output

• output GuidResponse

Apps_ListAvailableCustomPrebuiltDomainsForCulture

Gets all the available custom prebuilt domains for a specific culture.

azure_cognitiveservices_luis_programmatic.Apps_ListAvailableCustomPrebuiltDomainsForCulture({
  "culture": ""
}, context)

Input

• input object
  • culture required string: Culture.

Output

• output PrebuiltDomainsList

Apps_ListDomains

Gets the available application domains.

azure_cognitiveservices_luis_programmatic.Apps_ListDomains(null, context)

Input

This action has no parameters

Output

• output AvailableDomains

Apps_Import

Imports an application to LUIS, the application's structure should be included in in the request body.

azure_cognitiveservices_luis_programmatic.Apps_Import({
  "luisApp": {}
}, context)

Input

• input object
  • appName string: The application name to create. If not specified, the application name will be read from the imported object.
  • luisApp required LuisApp

Output

• output GuidResponse

Apps_ListUsageScenarios

Gets the application available usage scenarios.

azure_cognitiveservices_luis_programmatic.Apps_ListUsageScenarios(null, context)

Input

This action has no parameters

Output

• output ApplicationUsageScenarios

Apps_Delete

Deletes an application.

azure_cognitiveservices_luis_programmatic.Apps_Delete({
  "appId": ""
}, context)

Input

• input object
  • appId required string: The application ID.

Output

• output OperationStatus

Apps_Get

Gets the application info.

azure_cognitiveservices_luis_programmatic.Apps_Get({
  "appId": ""
}, context)

Input

• input object
  • appId required string: The application ID.

Output

• output ApplicationInfoResponse

Apps_Update

Updates the name or description of the application.

azure_cognitiveservices_luis_programmatic.Apps_Update({
  "appId": "",
  "applicationUpdateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • applicationUpdateObject required ApplicationUpdateObject

Output

• output OperationStatus

Apps_ListEndpoints

Returns the available endpoint deployment regions and URLs.

azure_cognitiveservices_luis_programmatic.Apps_ListEndpoints({
  "appId": ""
}, context)

Input

• input object
  • appId required string: The application ID.

Output

• output AvailableEndpoints

Permissions_Delete

Removes a user from the allowed list of users to access this LUIS application. Users are removed using their email address.

azure_cognitiveservices_luis_programmatic.Permissions_Delete({
  "appId": "",
  "userToDelete": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • userToDelete required UserCollaborator

Output

• output OperationStatus

Permissions_List

Gets the list of user emails that have permissions to access your application.

azure_cognitiveservices_luis_programmatic.Permissions_List({
  "appId": ""
}, context)

Input

• input object
  • appId required string: The application ID.

Output

• output UserAccessList

Permissions_Add

Adds a user to the allowed list of users to access this LUIS application. Users are added using their email address.

azure_cognitiveservices_luis_programmatic.Permissions_Add({
  "appId": "",
  "userToAdd": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • userToAdd required UserCollaborator

Output

• output OperationStatus

Permissions_Update

Replaces the current users access list with the one sent in the body. If an empty list is sent, all access to other users will be removed.

azure_cognitiveservices_luis_programmatic.Permissions_Update({
  "appId": "",
  "collaborators": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • collaborators required CollaboratorsArray

Output

• output OperationStatus

Apps_Publish

Publishes a specific version of the application.

azure_cognitiveservices_luis_programmatic.Apps_Publish({
  "appId": "",
  "applicationPublishObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • applicationPublishObject required ApplicationPublishObject

Output

• output ProductionOrStagingEndpointInfo

Apps_DownloadQueryLogs

Gets the query logs of the past month for the application.

azure_cognitiveservices_luis_programmatic.Apps_DownloadQueryLogs({
  "appId": ""
}, context)

Input

• input object
  • appId required string: The application ID.

Output

• output object: The query logs of an application for the past month in CSV format.

Apps_GetSettings

Get the application settings.

azure_cognitiveservices_luis_programmatic.Apps_GetSettings({
  "appId": ""
}, context)

Input

• input object
  • appId required string: The application ID.

Output

• output ApplicationSettings

Apps_UpdateSettings

Updates the application settings.

azure_cognitiveservices_luis_programmatic.Apps_UpdateSettings({
  "appId": "",
  "applicationSettingUpdateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • applicationSettingUpdateObject required ApplicationSettingUpdateObject

Output

• output OperationStatus

Versions_List

Gets the application versions info.

azure_cognitiveservices_luis_programmatic.Versions_List({
  "appId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • skip integer: The number of entries to skip. Default value is 0.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output array
  • items VersionInfo

Versions_Import

Imports a new version into a LUIS application.

azure_cognitiveservices_luis_programmatic.Versions_Import({
  "appId": "",
  "luisApp": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId string: The new versionId to import. If not specified, the versionId will be read from the imported object.
  • luisApp required LuisApp

Output

• output VersionResponse

Versions_Delete

Deletes an application version.

azure_cognitiveservices_luis_programmatic.Versions_Delete({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.

Output

• output OperationStatus

Versions_Get

Gets the version info.

azure_cognitiveservices_luis_programmatic.Versions_Get({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.

Output

• output VersionInfo

Versions_Update

Updates the name or description of the application version.

azure_cognitiveservices_luis_programmatic.Versions_Update({
  "appId": "",
  "versionId": "",
  "versionUpdateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • versionUpdateObject required TaskUpdateObject

Output

• output OperationStatus

Versions_Clone

Creates a new version using the current snapshot of the selected application version.

azure_cognitiveservices_luis_programmatic.Versions_Clone({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • versionCloneObject TaskUpdateObject

Output

• output string

Model_ListClosedLists

Gets information about the closedlist models.

azure_cognitiveservices_luis_programmatic.Model_ListClosedLists({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • skip integer: The number of entries to skip. Default value is 0.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output ClosedListEntityExtractorsList

Model_AddClosedList

Adds a closed list model to the application.

azure_cognitiveservices_luis_programmatic.Model_AddClosedList({
  "appId": "",
  "versionId": "",
  "closedListModelCreateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • closedListModelCreateObject required ClosedListModelCreateObject

Output

• output GuidResponse

Model_DeleteClosedList

Deletes a closed list model from the application.

azure_cognitiveservices_luis_programmatic.Model_DeleteClosedList({
  "appId": "",
  "versionId": "",
  "clEntityId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • clEntityId required string: The closed list model ID.

Output

• output OperationStatus

Model_GetClosedList

Gets information of a closed list model.

azure_cognitiveservices_luis_programmatic.Model_GetClosedList({
  "appId": "",
  "versionId": "",
  "clEntityId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • clEntityId required string: The closed list model ID.

Output

• output ClosedListEntityExtractor

Model_PatchClosedList

Adds a batch of sublists to an existing closedlist.

azure_cognitiveservices_luis_programmatic.Model_PatchClosedList({
  "appId": "",
  "versionId": "",
  "clEntityId": "",
  "closedListModelPatchObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • clEntityId required string: The closed list model ID.
  • closedListModelPatchObject required ClosedListModelPatchObject

Output

• output OperationStatus

Model_UpdateClosedList

Updates the closed list model.

azure_cognitiveservices_luis_programmatic.Model_UpdateClosedList({
  "appId": "",
  "versionId": "",
  "clEntityId": "",
  "closedListModelUpdateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • clEntityId required string: The closed list model ID.
  • closedListModelUpdateObject required ClosedListModelUpdateObject

Output

• output OperationStatus

Model_AddSubList

Adds a list to an existing closed list.

azure_cognitiveservices_luis_programmatic.Model_AddSubList({
  "appId": "",
  "versionId": "",
  "clEntityId": "",
  "wordListCreateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • clEntityId required string: The closed list entity extractor ID.
  • wordListCreateObject required WordListObject

Output

• output integer

Model_DeleteSubList

Deletes a sublist of a specific closed list model.

azure_cognitiveservices_luis_programmatic.Model_DeleteSubList({
  "appId": "",
  "versionId": "",
  "clEntityId": "",
  "subListId": 0
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • clEntityId required string: The closed list entity extractor ID.
  • subListId required integer: The sublist ID.

Output

• output OperationStatus

Model_UpdateSubList

Updates one of the closed list's sublists.

azure_cognitiveservices_luis_programmatic.Model_UpdateSubList({
  "appId": "",
  "versionId": "",
  "clEntityId": "",
  "subListId": 0,
  "wordListBaseUpdateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • clEntityId required string: The closed list entity extractor ID.
  • subListId required integer: The sublist ID.
  • wordListBaseUpdateObject required WordListBaseUpdateObject

Output

• output OperationStatus

Model_ListCompositeEntities

Gets information about the composite entity models.

azure_cognitiveservices_luis_programmatic.Model_ListCompositeEntities({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • skip integer: The number of entries to skip. Default value is 0.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output CompositeEntityExtractorsList

Model_AddCompositeEntity

Adds a composite entity extractor to the application.

azure_cognitiveservices_luis_programmatic.Model_AddCompositeEntity({
  "appId": "",
  "versionId": "",
  "compositeModelCreateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • compositeModelCreateObject required CompositeEntityModel

Output

• output GuidResponse

Model_DeleteCompositeEntity

Deletes a composite entity extractor from the application.

azure_cognitiveservices_luis_programmatic.Model_DeleteCompositeEntity({
  "appId": "",
  "versionId": "",
  "cEntityId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • cEntityId required string: The composite entity extractor ID.

Output

• output OperationStatus

Model_GetCompositeEntity

Gets information about the composite entity model.

azure_cognitiveservices_luis_programmatic.Model_GetCompositeEntity({
  "appId": "",
  "versionId": "",
  "cEntityId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • cEntityId required string: The composite entity extractor ID.

Output

• output CompositeEntityExtractor

Model_UpdateCompositeEntity

Updates the composite entity extractor.

azure_cognitiveservices_luis_programmatic.Model_UpdateCompositeEntity({
  "appId": "",
  "versionId": "",
  "cEntityId": "",
  "compositeModelUpdateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • cEntityId required string: The composite entity extractor ID.
  • compositeModelUpdateObject required CompositeEntityModel

Output

• output OperationStatus

Model_AddCompositeEntityChild

Creates a single child in an existing composite entity model.

azure_cognitiveservices_luis_programmatic.Model_AddCompositeEntityChild({
  "appId": "",
  "versionId": "",
  "cEntityId": "",
  "compositeChildModelCreateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • cEntityId required string: The composite entity extractor ID.
  • compositeChildModelCreateObject required object
    • name string

Output

• output GuidResponse

Model_DeleteCompositeEntityChild

Deletes a composite entity extractor child from the application.

azure_cognitiveservices_luis_programmatic.Model_DeleteCompositeEntityChild({
  "appId": "",
  "versionId": "",
  "cEntityId": "",
  "cChildId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • cEntityId required string: The composite entity extractor ID.
  • cChildId required string: The hierarchical entity extractor child ID.

Output

• output OperationStatus

Model_AddCustomPrebuiltDomain

Adds a customizable prebuilt domain along with all of its models to this application.

azure_cognitiveservices_luis_programmatic.Model_AddCustomPrebuiltDomain({
  "appId": "",
  "versionId": "",
  "prebuiltDomainObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • prebuiltDomainObject required PrebuiltDomainCreateBaseObject

Output

• output GuidList

Model_DeleteCustomPrebuiltDomain

Deletes a prebuilt domain's models from the application.

azure_cognitiveservices_luis_programmatic.Model_DeleteCustomPrebuiltDomain({
  "appId": "",
  "versionId": "",
  "domainName": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • domainName required string: Domain name.

Output

• output OperationStatus

Model_ListCustomPrebuiltEntities

Gets all custom prebuilt entities information of this application.

azure_cognitiveservices_luis_programmatic.Model_ListCustomPrebuiltEntities({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.

Output

• output EntityExtractorsList

Model_AddCustomPrebuiltEntity

Adds a custom prebuilt entity model to the application.

azure_cognitiveservices_luis_programmatic.Model_AddCustomPrebuiltEntity({
  "appId": "",
  "versionId": "",
  "prebuiltDomainModelCreateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • prebuiltDomainModelCreateObject required PrebuiltDomainModelCreateObject

Output

• output GuidResponse

Model_ListCustomPrebuiltIntents

Gets custom prebuilt intents information of this application.

azure_cognitiveservices_luis_programmatic.Model_ListCustomPrebuiltIntents({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.

Output

• output IntentClassifiersList

Model_AddCustomPrebuiltIntent

Adds a custom prebuilt intent model to the application.

azure_cognitiveservices_luis_programmatic.Model_AddCustomPrebuiltIntent({
  "appId": "",
  "versionId": "",
  "prebuiltDomainModelCreateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • prebuiltDomainModelCreateObject required PrebuiltDomainModelCreateObject

Output

• output GuidResponse

Model_ListCustomPrebuiltModels

Gets all custom prebuilt models information of this application.

azure_cognitiveservices_luis_programmatic.Model_ListCustomPrebuiltModels({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.

Output

• output CustomPrebuiltModelList

Model_ListEntities

Gets information about the entity models.

azure_cognitiveservices_luis_programmatic.Model_ListEntities({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • skip integer: The number of entries to skip. Default value is 0.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output EntityExtractorsList

Model_AddEntity

Adds an entity extractor to the application.

azure_cognitiveservices_luis_programmatic.Model_AddEntity({
  "appId": "",
  "versionId": "",
  "modelCreateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • modelCreateObject required ModelCreateObject

Output

• output GuidResponse

Model_DeleteEntity

Deletes an entity extractor from the application.

azure_cognitiveservices_luis_programmatic.Model_DeleteEntity({
  "appId": "",
  "versionId": "",
  "entityId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • entityId required string: The entity extractor ID.

Output

• output OperationStatus

Model_GetEntity

Gets information about the entity model.

azure_cognitiveservices_luis_programmatic.Model_GetEntity({
  "appId": "",
  "versionId": "",
  "entityId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • entityId required string: The entity extractor ID.

Output

• output EntityExtractor

Model_UpdateEntity

Updates the name of an entity extractor.

azure_cognitiveservices_luis_programmatic.Model_UpdateEntity({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "modelUpdateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • entityId required string: The entity extractor ID.
  • modelUpdateObject required ModelUpdateObject

Output

• output OperationStatus

Model_GetEntitySuggestions

Get suggestion examples that would improve the accuracy of the entity model.

azure_cognitiveservices_luis_programmatic.Model_GetEntitySuggestions({
  "appId": "",
  "versionId": "",
  "entityId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • entityId required string: The target entity extractor model to enhance.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output EntitiesSuggestionExamples

Examples_Add

Adds a labeled example to the application.

azure_cognitiveservices_luis_programmatic.Examples_Add({
  "appId": "",
  "versionId": "",
  "exampleLabelObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • exampleLabelObject required ExampleLabelObject

Output

• output LabelExampleResponse

Examples_List

Returns examples to be reviewed.

azure_cognitiveservices_luis_programmatic.Examples_List({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • skip integer: The number of entries to skip. Default value is 0.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output LabeledUtterances

Examples_Batch

Adds a batch of labeled examples to the application.

azure_cognitiveservices_luis_programmatic.Examples_Batch({
  "appId": "",
  "versionId": "",
  "exampleLabelObjectArray": []
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • exampleLabelObjectArray required ExampleLabelObjectArray

Output

• output BatchLabelExampleResponse

Examples_Delete

Deletes the labeled example with the specified ID.

azure_cognitiveservices_luis_programmatic.Examples_Delete({
  "appId": "",
  "versionId": "",
  "exampleId": 0
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • exampleId required integer: The example ID.

Output

• output OperationStatus

Versions_Export

Exports a LUIS application to JSON format.

azure_cognitiveservices_luis_programmatic.Versions_Export({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.

Output

• output LuisApp

Features_List

Gets all the extraction features for the specified application version.

azure_cognitiveservices_luis_programmatic.Features_List({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • skip integer: The number of entries to skip. Default value is 0.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output FeaturesResponseObject

Model_ListHierarchicalEntities

Gets information about the hierarchical entity models.

azure_cognitiveservices_luis_programmatic.Model_ListHierarchicalEntities({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • skip integer: The number of entries to skip. Default value is 0.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output HierarchicalEntityExtractorsList

Model_AddHierarchicalEntity

Adds a hierarchical entity extractor to the application version.

azure_cognitiveservices_luis_programmatic.Model_AddHierarchicalEntity({
  "appId": "",
  "versionId": "",
  "hierarchicalModelCreateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • hierarchicalModelCreateObject required HierarchicalEntityModel

Output

• output GuidResponse

Model_DeleteHierarchicalEntity

Deletes a hierarchical entity extractor from the application version.

azure_cognitiveservices_luis_programmatic.Model_DeleteHierarchicalEntity({
  "appId": "",
  "versionId": "",
  "hEntityId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • hEntityId required string: The hierarchical entity extractor ID.

Output

• output OperationStatus

Model_GetHierarchicalEntity

Gets information about the hierarchical entity model.

azure_cognitiveservices_luis_programmatic.Model_GetHierarchicalEntity({
  "appId": "",
  "versionId": "",
  "hEntityId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • hEntityId required string: The hierarchical entity extractor ID.

Output

• output HierarchicalEntityExtractor

Model_UpdateHierarchicalEntity

Updates the name and children of a hierarchical entity model.

azure_cognitiveservices_luis_programmatic.Model_UpdateHierarchicalEntity({
  "appId": "",
  "versionId": "",
  "hEntityId": "",
  "hierarchicalModelUpdateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • hEntityId required string: The hierarchical entity extractor ID.
  • hierarchicalModelUpdateObject required HierarchicalEntityModel

Output

• output OperationStatus

Model_AddHierarchicalEntityChild

Creates a single child in an existing hierarchical entity model.

azure_cognitiveservices_luis_programmatic.Model_AddHierarchicalEntityChild({
  "appId": "",
  "versionId": "",
  "hEntityId": "",
  "hierarchicalChildModelCreateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • hEntityId required string: The hierarchical entity extractor ID.
  • hierarchicalChildModelCreateObject required object
    • name string

Output

• output GuidResponse

Model_DeleteHierarchicalEntityChild

Deletes a hierarchical entity extractor child from the application.

azure_cognitiveservices_luis_programmatic.Model_DeleteHierarchicalEntityChild({
  "appId": "",
  "versionId": "",
  "hEntityId": "",
  "hChildId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • hEntityId required string: The hierarchical entity extractor ID.
  • hChildId required string: The hierarchical entity extractor child ID.

Output

• output OperationStatus

Model_GetHierarchicalEntityChild

Gets information about the hierarchical entity child model.

azure_cognitiveservices_luis_programmatic.Model_GetHierarchicalEntityChild({
  "appId": "",
  "versionId": "",
  "hEntityId": "",
  "hChildId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • hEntityId required string: The hierarchical entity extractor ID.
  • hChildId required string: The hierarchical entity extractor child ID.

Output

• output HierarchicalChildEntity

Model_UpdateHierarchicalEntityChild

Renames a single child in an existing hierarchical entity model.

azure_cognitiveservices_luis_programmatic.Model_UpdateHierarchicalEntityChild({
  "appId": "",
  "versionId": "",
  "hEntityId": "",
  "hChildId": "",
  "hierarchicalChildModelUpdateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • hEntityId required string: The hierarchical entity extractor ID.
  • hChildId required string: The hierarchical entity extractor child ID.
  • hierarchicalChildModelUpdateObject required object
    • name string

Output

• output OperationStatus

Model_ListIntents

Gets information about the intent models.

azure_cognitiveservices_luis_programmatic.Model_ListIntents({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • skip integer: The number of entries to skip. Default value is 0.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output IntentClassifiersList

Model_AddIntent

Adds an intent classifier to the application.

azure_cognitiveservices_luis_programmatic.Model_AddIntent({
  "appId": "",
  "versionId": "",
  "intentCreateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • intentCreateObject required ModelCreateObject

Output

• output GuidResponse

Model_DeleteIntent

Deletes an intent classifier from the application.

azure_cognitiveservices_luis_programmatic.Model_DeleteIntent({
  "appId": "",
  "versionId": "",
  "intentId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • intentId required string: The intent classifier ID.
  • deleteUtterances boolean: Also delete the intent's utterances (true). Or move the utterances to the None intent (false - the default value).

Output

• output OperationStatus

Model_GetIntent

Gets information about the intent model.

azure_cognitiveservices_luis_programmatic.Model_GetIntent({
  "appId": "",
  "versionId": "",
  "intentId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • intentId required string: The intent classifier ID.

Output

• output IntentClassifier

Model_UpdateIntent

Updates the name of an intent classifier.

azure_cognitiveservices_luis_programmatic.Model_UpdateIntent({
  "appId": "",
  "versionId": "",
  "intentId": "",
  "modelUpdateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • intentId required string: The intent classifier ID.
  • modelUpdateObject required ModelUpdateObject

Output

• output OperationStatus

Model_GetIntentSuggestions

Suggests examples that would improve the accuracy of the intent model.

azure_cognitiveservices_luis_programmatic.Model_GetIntentSuggestions({
  "appId": "",
  "versionId": "",
  "intentId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • intentId required string: The intent classifier ID.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output IntentsSuggestionExamples

Model_ListPrebuiltEntities

Gets all the available prebuilt entity extractors for the application.

azure_cognitiveservices_luis_programmatic.Model_ListPrebuiltEntities({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.

Output

• output AvailablePrebuiltEntityModels

Model_ListModels

Gets information about the application version models.

azure_cognitiveservices_luis_programmatic.Model_ListModels({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • skip integer: The number of entries to skip. Default value is 0.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output ModelsInfoResponseObject

Features_GetApplicationVersionPatternFeatures

DEPRECATED NOTICE: This operation will soon be removed Gets all the pattern features.

azure_cognitiveservices_luis_programmatic.Features_GetApplicationVersionPatternFeatures({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • skip integer: The number of entries to skip. Default value is 0.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output PatternFeatureInfoList

Features_CreatePatternFeature

DEPRECATED NOTICE: This operation will soon be removed Creates a new pattern feature.

azure_cognitiveservices_luis_programmatic.Features_CreatePatternFeature({
  "appId": "",
  "versionId": "",
  "patternCreateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • patternCreateObject required PatternCreateObject

Output

• output FeatureIDResponse

Features_DeletePatternFeature

DEPRECATED NOTICE: This operation will soon be removed Deletes a pattern feature.

azure_cognitiveservices_luis_programmatic.Features_DeletePatternFeature({
  "appId": "",
  "versionId": "",
  "patternId": 0
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • patternId required integer: The pattern feature ID.

Output

• output OperationStatus

Features_GetPatternFeatureInfo

DEPRECATED NOTICE: This operation will soon be removed Gets the specified pattern feature's info.

azure_cognitiveservices_luis_programmatic.Features_GetPatternFeatureInfo({
  "appId": "",
  "versionId": "",
  "patternId": 0
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • patternId required integer: The pattern feature ID.

Output

• output PatternFeatureInfo

Features_UpdatePatternFeature

DEPRECATED NOTICE: This operation will soon be removed Updates the pattern, the name and the state of the pattern feature.

azure_cognitiveservices_luis_programmatic.Features_UpdatePatternFeature({
  "appId": "",
  "versionId": "",
  "patternId": 0,
  "patternUpdateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • patternId required integer: The pattern feature ID.
  • patternUpdateObject required PatternUpdateObject

Output

• output OperationStatus

Features_ListPhraseLists

Gets all the phraselist features.

azure_cognitiveservices_luis_programmatic.Features_ListPhraseLists({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • skip integer: The number of entries to skip. Default value is 0.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output PhraseListFeatureInfoList

Features_AddPhraseList

Creates a new phraselist feature.

azure_cognitiveservices_luis_programmatic.Features_AddPhraseList({
  "appId": "",
  "versionId": "",
  "phraselistCreateObject": {}
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • phraselistCreateObject required PhraselistCreateObject

Output

• output FeatureIDResponse

Features_DeletePhraseList

Deletes a phraselist feature.

azure_cognitiveservices_luis_programmatic.Features_DeletePhraseList({
  "appId": "",
  "versionId": "",
  "phraselistId": 0
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • phraselistId required integer: The ID of the feature to be deleted.

Output

• output OperationStatus

Features_GetPhraseList

Gets phraselist feature info.

azure_cognitiveservices_luis_programmatic.Features_GetPhraseList({
  "appId": "",
  "versionId": "",
  "phraselistId": 0
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • phraselistId required integer: The ID of the feature to be retrieved.

Output

• output PhraseListFeatureInfo

Features_UpdatePhraseList

Updates the phrases, the state and the name of the phraselist feature.

azure_cognitiveservices_luis_programmatic.Features_UpdatePhraseList({
  "appId": "",
  "versionId": "",
  "phraselistId": 0
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • phraselistId required integer: The ID of the feature to be updated.
  • phraselistUpdateObject PhraselistUpdateObject

Output

• output OperationStatus

Model_ListPrebuilts

Gets information about the prebuilt entity models.

azure_cognitiveservices_luis_programmatic.Model_ListPrebuilts({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • skip integer: The number of entries to skip. Default value is 0.
  • take integer: The number of entries to return. Maximum page size is 500. Default is 100.

Output

• output PrebuiltEntityExtractorsList

Model_AddPrebuilt

Adds a list of prebuilt entity extractors to the application.

azure_cognitiveservices_luis_programmatic.Model_AddPrebuilt({
  "appId": "",
  "versionId": "",
  "prebuiltExtractorNames": []
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • prebuiltExtractorNames required PrebuiltExtractorNames

Output

• output PrebuiltEntityExtractorsList

Model_DeletePrebuilt

Deletes a prebuilt entity extractor from the application.

azure_cognitiveservices_luis_programmatic.Model_DeletePrebuilt({
  "appId": "",
  "versionId": "",
  "prebuiltId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • prebuiltId required string: The prebuilt entity extractor ID.

Output

• output OperationStatus

Model_GetPrebuilt

Gets information about the prebuilt entity model.

azure_cognitiveservices_luis_programmatic.Model_GetPrebuilt({
  "appId": "",
  "versionId": "",
  "prebuiltId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • prebuiltId required string: The prebuilt entity extractor ID.

Output

• output PrebuiltEntityExtractor

Versions_DeleteUnlabelledUtterance

Deleted an unlabelled utterance.

azure_cognitiveservices_luis_programmatic.Versions_DeleteUnlabelledUtterance({
  "appId": "",
  "versionId": "",
  "utterance": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.
  • utterance required string

Output

• output OperationStatus

Train_GetStatus

Gets the training status of all models (intents and entities) for the specified LUIS app. You must call the train API to train the LUIS app before you call this API to get training status. "appID" specifies the LUIS app ID. "versionId" specifies the version number of the LUIS app. For example, "0.1".

azure_cognitiveservices_luis_programmatic.Train_GetStatus({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.

Output

• output ModelTrainingInfoList

Train_TrainVersion

Sends a training request for a version of a specified LUIS app. This POST request initiates a request asynchronously. To determine whether the training request is successful, submit a GET request to get training status. Note: The application version is not fully trained unless all the models (intents and entities) are trained successfully or are up to date. To verify training success, get the training status at least once after training is complete.

azure_cognitiveservices_luis_programmatic.Train_TrainVersion({
  "appId": "",
  "versionId": ""
}, context)

Input

• input object
  • appId required string: The application ID.
  • versionId required string: The version ID.

Output

• output EnqueueTrainingResponse

Definitions

ApplicationCreateObject

• ApplicationCreateObject object: Properties for creating a new LUIS Application
  • culture required string: The culture for the new application. It is the language that your app understands and speaks. E.g.: "en-us". Note: the culture cannot be changed after the app is created.
  • description string: Description of the new application. Optional.
  • domain string: The domain for the new application. Optional. E.g.: Comics.
  • initialVersionId string: The initial version ID. Optional. Default value is: "0.1"
  • name required string: The name for the new application.
  • usageScenario string: Defines the scenario for the new application. Optional. E.g.: IoT.

ApplicationInfoResponse

• ApplicationInfoResponse object: Response containing the Application Info.
  • activeVersion string: The version ID currently marked as active.
  • createdDateTime string: The version's creation timestamp.
  • culture string: The culture of the application. E.g.: en-us.
  • description string: The description of the application.
  • domain string: The domain for the new application. Optional. E.g.: Comics.
  • endpointHitsCount integer: Number of calls made to this endpoint.
  • endpoints object: The Runtime endpoint URL for this model version.
  • id string: The ID (GUID) of the application.
  • name string: The name of the application.
  • usageScenario string: Defines the scenario for the new application. Optional. E.g.: IoT.
  • versionsCount integer: Amount of model versions within the application.

ApplicationPublishObject

• ApplicationPublishObject object: Object model for publishing a specific application version.
  • isStaging boolean: Indicates if the staging slot should be used, instead of the Production one.
  • region string: The target region that the application is published to.
  • versionId string: The version ID to publish.

ApplicationSettingUpdateObject

• ApplicationSettingUpdateObject object: Object model for updating an application's settings.
  • public boolean: Setting your application as public allows other people to use your application's endpoint using their own keys.

ApplicationSettings

• ApplicationSettings object: The application settings.
  • id required string: The application ID.
  • public required boolean: Setting your application as public allows other people to use your application's endpoint using their own keys.

ApplicationUpdateObject

• ApplicationUpdateObject object: Object model for updating the name or description of an application.
  • description string: The application's new description.
  • name string: The application's new name.

ApplicationUsageScenarios

• ApplicationUsageScenarios array: A list of possible application usage scenarios.
  • items string

ApplicationsInfoList

• ApplicationsInfoList array: List of Application Infos.
  • items ApplicationInfoResponse

AvailableCulture

• AvailableCulture object: Available culture for using in a new application.
  • code string: The ISO value for the language.
  • name string: The language name.

AvailableCultures

• AvailableCultures array: A list of available application cultures.
  • items AvailableCulture

AvailableDomains

• AvailableDomains array: A list of available application domains.
  • items string

AvailableEndpoints

• AvailableEndpoints object: Collection of endpoint URLs where the selected application is deployed to.

AvailablePrebuiltEntityModel

• AvailablePrebuiltEntityModel object: Available Prebuilt entity model for using in an application.
  • description string: The entity description and usage information.
  • examples string: Usage examples.
  • name string: The entity name.

AvailablePrebuiltEntityModels

• AvailablePrebuiltEntityModels array: List of Available Prebuilt entity models.
  • items AvailablePrebuiltEntityModel

BatchLabelExample

• BatchLabelExample object: Response when adding a batch of labeled examples.
  • error OperationStatus
  • hasError boolean
  • value LabelExampleResponse

BatchLabelExampleResponse

• BatchLabelExampleResponse array: Response when adding a batch of labeled examples.
  • items BatchLabelExample

ChildEntity

• ChildEntity object: The base child entity type.
  • id required string: The ID (GUID) belonging to a child entity.
  • name string: The name of a child entity.

ClosedList

• ClosedList object: Exported Model - A Closed List.
  • name string: Name of the closed list feature.
  • subLists array: Sublists for the feature.
    • items SubClosedList

ClosedListEntityExtractor

• ClosedListEntityExtractor object: Closed List Entity Extractor.
  • subLists array: List of sub-lists.
    • items SubClosedListResponse
  • id required string: The ID of the Entity Model.
  • name string: Name of the Entity Model.
  • readableType required ReadableType
  • typeId integer: The type ID of the Entity Model.

ClosedListEntityExtractorsList

• ClosedListEntityExtractorsList array: List of Closed List Entity Extractors.
  • items ClosedListEntityExtractor

ClosedListModelCreateObject

• ClosedListModelCreateObject object: Object model for creating a closed list.
  • name string: Name of the closed list feature.
  • subLists array: Sublists for the feature.
    • items WordListObject

ClosedListModelPatchObject

• ClosedListModelPatchObject object: Object model for adding a batch of sublists to an existing closedlist.
  • subLists array: Sublists to add.
    • items WordListObject

ClosedListModelUpdateObject

• ClosedListModelUpdateObject object: Object model for updating a closed list.
  • name string: The new name of the closed list feature.
  • subLists array: The new sublists for the feature.
    • items WordListObject

CollaboratorsArray

• CollaboratorsArray object
  • emails array: The email address of the users.
    • items string

CompositeEntityExtractor

• CompositeEntityExtractor object: A Composite Entity Extractor.
  • children array: List of child entities.
    • items ChildEntity
  • id required string: The ID of the Entity Model.
  • name string: Name of the Entity Model.
  • readableType required ReadableType
  • typeId integer: The type ID of the Entity Model.

CompositeEntityExtractorsList

• CompositeEntityExtractorsList array: List of Composite Entity Extractors.
  • items CompositeEntityExtractor

CompositeEntityModel

• CompositeEntityModel object: A composite entity.
  • children array: Child entities.
    • items string
  • name string: Entity name.

CustomPrebuiltModel

• CustomPrebuiltModel: A Custom Prebuilt model.
  • id required string: The ID of the Entity Model.
  • name string: Name of the Entity Model.
  • readableType required ReadableType
  • typeId integer: The type ID of the Entity Model.
  • customPrebuiltDomainName string: The domain name.
  • customPrebuiltModelName string: The intent name or entity name.
  • id required string: The ID of the Entity Model.
  • name string: Name of the Entity Model.
  • readableType required ReadableType
  • typeId integer: The type ID of the Entity Model.
  • customPrebuiltDomainName string: The domain name.
  • customPrebuiltModelName string: The intent name or entity name.
  • id required string: The ID of the Entity Model.
  • name string: Name of the Entity Model.
  • readableType required ReadableType
  • typeId integer: The type ID of the Entity Model.

CustomPrebuiltModelList

• CustomPrebuiltModelList array: A List of Custom Prebuilt models.
  • items CustomPrebuiltModel

EndpointInfo

• EndpointInfo object: The base class "ProductionOrStagingEndpointInfo" inherits from.
  • assignedEndpointKey string: The endpoint key.
  • endpointRegion string: The endpoint's region.
  • endpointUrl string: The Runtime endpoint URL for this model version.
  • isStaging boolean: Indicates if the staging slot should be used, instead of the Production one.
  • publishedDateTime string: Timestamp when was last published.
  • region string: The target region that the application is published to.
  • versionId string: The version ID to publish.

EndpointKeys

• EndpointKeys array: An a array of GUIDs, comprised of Azure Endpoint Keys and the Programmatic API key.
  • items string

EnqueueTrainingResponse

• EnqueueTrainingResponse object: Response model when requesting to train the model.
  • status TrainingStatus
  • statusId integer: The train request status ID.

EntitiesSuggestionExample

• EntitiesSuggestionExample object: Predicted/suggested entity.
  • entityPredictions array: Predicted/suggested entities.
    • items EntityPrediction
  • intentPredictions array: Predicted/suggested intents.
    • items IntentPrediction
  • text string: The utterance. E.g.: what's the weather like in seattle?
  • tokenizedText array: The utterance tokenized.
    • items string

EntitiesSuggestionExamples

• EntitiesSuggestionExamples array: List of predicted/suggested entities.
  • items EntitiesSuggestionExample

EntityExtractor

• EntityExtractor object: Entity Extractor.
  • customPrebuiltDomainName string: The domain name.
  • customPrebuiltModelName string: The intent name or entity name.
  • id required string: The ID of the Entity Model.
  • name string: Name of the Entity Model.
  • readableType required ReadableType
  • typeId integer: The type ID of the Entity Model.

EntityExtractorsList

• EntityExtractorsList array: List of Entity Extractors.
  • items EntityExtractor

EntityLabel

• EntityLabel object: Defines the entity type and position of the extracted entity within the example.
  • endTokenIndex required integer: The index within the utterance where the extracted entity ends.
  • entityName required string: The entity type.
  • startTokenIndex required integer: The index within the utterance where the extracted entity starts.

EntityLabelObject

• EntityLabelObject object: Defines the entity type and position of the extracted entity within the example.
  • endCharIndex required integer: The index within the utterance where the extracted entity ends.
  • entityName required string: The entity type.
  • startCharIndex required integer: The index within the utterance where the extracted entity starts.

EntityPrediction

• EntityPrediction object: A suggested entity.
  • endTokenIndex required integer: The index within the utterance where the extracted entity ends.
  • entityName required string: The entity's name
  • phrase required string: The actual token(s) that comprise the entity.
  • startTokenIndex required integer: The index within the utterance where the extracted entity starts.

ErrorResponse

• ErrorResponse object: Error response when invoking an operation on the API.
  • errorType string

ExampleLabelObject

• ExampleLabelObject object: A labeled example.
  • entityLabels array: The idenfied entities within the utterance.
    • items EntityLabelObject
  • intentName string: The idenfitied intent representing the utterance.
  • text string: The sample's utterance.

ExampleLabelObjectArray

• ExampleLabelObjectArray array: Object model for adding a batch of labeled examples.
  • items ExampleLabelObject

FeatureIDResponse

• FeatureIDResponse integer: The ID of the created feature.

FeatureInfoObject

• FeatureInfoObject object: The base class Features-related response objects inherit from.
  • id integer: A six-digit ID used for Features.
  • isActive boolean: Indicates if the feature is enabled.
  • name string: The name of the Feature.

FeaturesResponseObject

• FeaturesResponseObject object: Model Features, including Patterns and Phraselists.
  • patternFeatures PatternFeatureInfoList
  • phraselistFeatures PhraseListFeatureInfoList

GuidList

• GuidList array: List of IDs (GUID)
  • items GuidResponse

GuidResponse

• GuidResponse string: The ID (GUID) returned by an operation.

HierarchicalChildEntity

• HierarchicalChildEntity object: A Hierarchical Child Entity.
  • readableType ReadableType
  • typeId integer: The type ID of the Entity Model.
  • id required string: The ID (GUID) belonging to a child entity.
  • name string: The name of a child entity.

HierarchicalEntityExtractor

• HierarchicalEntityExtractor object: Hierarchical Entity Extractor.
  • children array: List of child entities.
    • items ChildEntity
  • id required string: The ID of the Entity Model.
  • name string: Name of the Entity Model.
  • readableType required ReadableType
  • typeId integer: The type ID of the Entity Model.

HierarchicalEntityExtractorsList

• HierarchicalEntityExtractorsList array: List of Hierarchical Entity Extractors.
  • items HierarchicalEntityExtractor

HierarchicalEntityModel

• HierarchicalEntityModel object: A Hierarchical Entity Extractor.
  • children array: Child entities.
    • items string
  • name string: Entity name.

HierarchicalModel

• HierarchicalModel object
  • children array
    • items string
  • name string

IntentClassifier

• IntentClassifier object: Intent Classifier.
  • customPrebuiltDomainName string: The domain name.
  • customPrebuiltModelName string: The intent name or entity name.
  • id required string: The ID of the Entity Model.
  • name string: Name of the Entity Model.
  • readableType required ReadableType
  • typeId integer: The type ID of the Entity Model.

IntentClassifiersList

• IntentClassifiersList array: List of Intent Classifiers.
  • items IntentClassifier

IntentPrediction

• IntentPrediction object: A suggested intent.
  • name string: The intent's name
  • score number: The intent's score, based on the prediction model.

IntentsSuggestionExample

• IntentsSuggestionExample object: Predicted/suggested intent.
  • entityPredictions array: Predicted/suggested entities.
    • items EntityPrediction
  • intentPredictions array: Predicted/suggested intents.
    • items IntentPrediction
  • text string: The utterance. E.g.: what's the weather like in seattle?
  • tokenizedText array: The utterance tokenized.
    • items string

IntentsSuggestionExamples

• IntentsSuggestionExamples array: List of predicted/suggested intents.
  • items IntentsSuggestionExample

JSONEntity

• JSONEntity object: Exported Model - Extracted Entity from utterance.
  • endPos required integer: The index within the utterance where the extracted entity ends.
  • entity required string: The entity name.
  • startPos required integer: The index within the utterance where the extracted entity starts.

JSONModelFeature

• JSONModelFeature object: Exported Model - Phraselist Model Feature.
  • activated boolean: Indicates if the feature is enabled.
  • mode boolean: An exchangeable phrase list feature are serves as single feature to the LUIS underlying training alg