3.0.0 • Published 5 years ago

@datafire/azure_cognitiveservices_luis_authoring v3.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/azure_cognitiveservices_luis_authoring

Client library for LUIS Authoring Client

Installation and Usage

npm install --save @datafire/azure_cognitiveservices_luis_authoring
let azure_cognitiveservices_luis_authoring = require('@datafire/azure_cognitiveservices_luis_authoring').create({
  apiKeyHeader: ""
});

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

Description

Actions

Apps_List

Lists all of the user's applications.

azure_cognitiveservices_luis_authoring.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

Apps_Add

Creates a new LUIS app.

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

Input

Output

Apps_ListCortanaEndpoints

Gets the endpoint URLs for the prebuilt Cortana applications.

azure_cognitiveservices_luis_authoring.Apps_ListCortanaEndpoints(null, context)

Input

This action has no parameters

Output

Apps_ListSupportedCultures

Gets a list of supported cultures. Cultures are equivalent to the written language and locale. For example,"en-us" represents the U.S. variation of English.

azure_cognitiveservices_luis_authoring.Apps_ListSupportedCultures(null, context)

Input

This action has no parameters

Output

Apps_ListAvailableCustomPrebuiltDomains

Gets all the available custom prebuilt domains for all cultures.

azure_cognitiveservices_luis_authoring.Apps_ListAvailableCustomPrebuiltDomains(null, context)

Input

This action has no parameters

Output

Apps_AddCustomPrebuiltDomain

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

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

Input

Output

Apps_ListAvailableCustomPrebuiltDomainsForCulture

Gets all the available prebuilt domains for a specific culture.

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

Input

  • input object
    • culture required string: Culture.

Output

Apps_ListDomains

Gets the available application domains.

azure_cognitiveservices_luis_authoring.Apps_ListDomains(null, context)

Input

This action has no parameters

Output

Apps_Import

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

azure_cognitiveservices_luis_authoring.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. If the application name already exists, an error is returned.
    • luisApp required LuisApp

Output

Apps_ListUsageScenarios

Gets the application available usage scenarios.

azure_cognitiveservices_luis_authoring.Apps_ListUsageScenarios(null, context)

Input

This action has no parameters

Output

Apps_Delete

Deletes an application.

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

Input

  • input object
    • appId required string: The application ID.
    • force boolean: A flag to indicate whether to force an operation.

Output

Apps_Get

Gets the application info.

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

Input

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

Output

Apps_Update

Updates the name or description of the application.

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

Input

Output

AzureAccounts_RemoveFromApp

Removes assigned Azure account from the application.

azure_cognitiveservices_luis_authoring.AzureAccounts_RemoveFromApp({
  "appId": "",
  "Authorization": ""
}, context)

Input

  • input object
    • appId required string: The application ID.
    • Authorization required string: The bearer authorization header to use; containing the user's ARM token used to validate Azure accounts information.
    • azureAccountInfoObject AzureAccountInfoObject

Output

AzureAccounts_GetAssigned

Gets the LUIS Azure accounts assigned to the application for the user using his ARM token.

azure_cognitiveservices_luis_authoring.AzureAccounts_GetAssigned({
  "appId": "",
  "Authorization": ""
}, context)

Input

  • input object
    • appId required string: The application ID.
    • Authorization required string: The bearer authorization header to use; containing the user's ARM token used to validate Azure accounts information.

Output

AzureAccounts_AssignToApp

Assigns an Azure account to the application.

azure_cognitiveservices_luis_authoring.AzureAccounts_AssignToApp({
  "appId": "",
  "Authorization": ""
}, context)

Input

  • input object
    • appId required string: The application ID.
    • Authorization required string: The bearer authorization header to use; containing the user's ARM token used to validate Azure accounts information.
    • azureAccountInfoObject AzureAccountInfoObject

Output

Apps_ListEndpoints

Returns the available endpoint deployment regions and URLs.

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

Input

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

Output

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_authoring.Permissions_Delete({
  "appId": "",
  "userToDelete": {}
}, context)

Input

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

Output

Permissions_List

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

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

Input

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

Output

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_authoring.Permissions_Add({
  "appId": "",
  "userToAdd": {}
}, context)

Input

  • input object

Output

Permissions_Update

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

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

Input

  • input object

Output

Apps_Publish

Publishes a specific version of the application.

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

Input

Output

Apps_GetPublishSettings

Get the application publish settings including 'UseAllTrainingData'.

azure_cognitiveservices_luis_authoring.Apps_GetPublishSettings({
  "appId": ""
}, context)

Input

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

Output

Apps_UpdatePublishSettings

Updates the application publish settings including 'UseAllTrainingData'.

azure_cognitiveservices_luis_authoring.Apps_UpdatePublishSettings({
  "appId": "",
  "publishSettingUpdateObject": {}
}, context)

Input

Output

Apps_DownloadQueryLogs

Gets the logs of the past month's endpoint queries for the application.

azure_cognitiveservices_luis_authoring.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 including 'UseAllTrainingData'.

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

Input

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

Output

Apps_UpdateSettings

Updates the application settings including 'UseAllTrainingData'.

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

Input

Output

Versions_List

Gets a list of versions for this application ID.

azure_cognitiveservices_luis_authoring.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

Versions_Import

Imports a new version into a LUIS application.

azure_cognitiveservices_luis_authoring.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

Versions_Delete

Deletes an application version.

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

Input

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

Output

Versions_Get

Gets the version information such as date created, last modified date, endpoint URL, count of intents and entities, training and publishing status.

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

Input

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

Output

Versions_Update

Updates the name or description of the application version.

azure_cognitiveservices_luis_authoring.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

Versions_Clone

Creates a new version from the selected version.

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

Input

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

Output

  • output string

Model_ListClosedLists

Gets information about all the list entity models in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_AddClosedList

Adds a list entity model to a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_DeleteClosedList

Deletes a list entity model from a version of the application.

azure_cognitiveservices_luis_authoring.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 list entity model ID.

Output

Model_GetClosedList

Gets information about a list entity in a version of the application.

azure_cognitiveservices_luis_authoring.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 list model ID.

Output

Model_PatchClosedList

Adds a batch of sublists to an existing list entity in a version of the application.

azure_cognitiveservices_luis_authoring.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 list entity model ID.
    • closedListModelPatchObject required ClosedListModelPatchObject

Output

Model_UpdateClosedList

Updates the list entity in a version of the application.

azure_cognitiveservices_luis_authoring.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 list model ID.
    • closedListModelUpdateObject required ClosedListModelUpdateObject

Output

Model_AddSubList

Adds a sublist to an existing list entity in a version of the application.

azure_cognitiveservices_luis_authoring.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 list entity extractor ID.
    • wordListCreateObject required WordListObject

Output

  • output integer

Model_DeleteSubList

Deletes a sublist of a specific list entity model from a version of the application.

azure_cognitiveservices_luis_authoring.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 list entity extractor ID.
    • subListId required integer: The sublist ID.

Output

Model_UpdateSubList

Updates one of the list entity's sublists in a version of the application.

azure_cognitiveservices_luis_authoring.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 list entity extractor ID.
    • subListId required integer: The sublist ID.
    • wordListBaseUpdateObject required WordListBaseUpdateObject

Output

Model_ListClosedListEntityRoles

Get all roles for a list entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_ListClosedListEntityRoles({
  "appId": "",
  "versionId": "",
  "entityId": ""
}, context)

Input

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

Output

Model_CreateClosedListEntityRole

Create a role for a list entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_CreateClosedListEntityRole({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "entityRoleCreateObject": {}
}, context)

Input

  • input object
    • appId required string: The application ID.
    • versionId required string: The version ID.
    • entityId required string: The entity model ID.
    • entityRoleCreateObject required EntityRoleCreateObject

Output

Model_DeleteClosedListEntityRole

Delete a role for a given list entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_DeleteClosedListEntityRole({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "roleId": ""
}, context)

Input

  • input object
    • appId required string: The application ID.
    • versionId required string: The version ID.
    • entityId required string: The entity ID.
    • roleId required string: The entity role Id.

Output

Model_GetClosedListEntityRole

Get one role for a given list entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_GetClosedListEntityRole({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "roleId": ""
}, context)

Input

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

Output

Model_UpdateClosedListEntityRole

Update a role for a given list entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_UpdateClosedListEntityRole({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "roleId": "",
  "entityRoleUpdateObject": {}
}, context)

Input

  • input object
    • appId required string: The application ID.
    • versionId required string: The version ID.
    • entityId required string: The entity ID.
    • roleId required string: The entity role ID.
    • entityRoleUpdateObject required EntityRoleUpdateObject

Output

Model_ListCompositeEntities

Gets information about all the composite entity models in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_DeleteCompositeEntity

Deletes a composite entity from a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_GetCompositeEntity

Gets information about a composite entity in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_UpdateCompositeEntity

Updates a composite entity in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_AddCompositeEntityChild

Creates a single child in an existing composite entity model in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_DeleteCompositeEntityChild

Deletes a composite entity extractor child from a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_ListCompositeEntityRoles

Get all roles for a composite entity in a version of the application

azure_cognitiveservices_luis_authoring.Model_ListCompositeEntityRoles({
  "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

Model_CreateCompositeEntityRole

Create a role for a composite entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_CreateCompositeEntityRole({
  "appId": "",
  "versionId": "",
  "cEntityId": "",
  "entityRoleCreateObject": {}
}, context)

Input

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

Output

Model_DeleteCompositeEntityRole

Delete a role for a given composite entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_DeleteCompositeEntityRole({
  "appId": "",
  "versionId": "",
  "cEntityId": "",
  "roleId": ""
}, context)

Input

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

Output

Model_GetCompositeEntityRole

Get one role for a given composite entity in a version of the application

azure_cognitiveservices_luis_authoring.Model_GetCompositeEntityRole({
  "appId": "",
  "versionId": "",
  "cEntityId": "",
  "roleId": ""
}, context)

Input

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

Output

Model_UpdateCompositeEntityRole

Update a role for a given composite entity in a version of the application

azure_cognitiveservices_luis_authoring.Model_UpdateCompositeEntityRole({
  "appId": "",
  "versionId": "",
  "cEntityId": "",
  "roleId": "",
  "entityRoleUpdateObject": {}
}, context)

Input

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

Output

Model_AddCustomPrebuiltDomain

Adds a customizable prebuilt domain along with all of its intent and entity models in a version of the application.

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

Input

  • input object

Output

Model_DeleteCustomPrebuiltDomain

Deletes a prebuilt domain's models in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_ListCustomPrebuiltEntities

Gets all prebuilt entities used in a version of the application.

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

Input

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

Output

Model_AddCustomPrebuiltEntity

Adds a prebuilt entity model to a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_ListCustomPrebuiltEntityRoles

Get all roles for a prebuilt entity in a version of the application

azure_cognitiveservices_luis_authoring.Model_ListCustomPrebuiltEntityRoles({
  "appId": "",
  "versionId": "",
  "entityId": ""
}, context)

Input

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

Output

Model_CreateCustomPrebuiltEntityRole

Create a role for a prebuilt entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_CreateCustomPrebuiltEntityRole({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "entityRoleCreateObject": {}
}, context)

Input

  • input object
    • appId required string: The application ID.
    • versionId required string: The version ID.
    • entityId required string: The entity model ID.
    • entityRoleCreateObject required EntityRoleCreateObject

Output

Model_DeleteCustomEntityRole

Delete a role for a given prebuilt entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_DeleteCustomEntityRole({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "roleId": ""
}, context)

Input

  • input object
    • appId required string: The application ID.
    • versionId required string: The version ID.
    • entityId required string: The entity ID.
    • roleId required string: The entity role Id.

Output

Model_GetCustomEntityRole

Get one role for a given prebuilt entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_GetCustomEntityRole({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "roleId": ""
}, context)

Input

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

Output

Model_UpdateCustomPrebuiltEntityRole

Update a role for a given prebuilt entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_UpdateCustomPrebuiltEntityRole({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "roleId": "",
  "entityRoleUpdateObject": {}
}, context)

Input

  • input object
    • appId required string: The application ID.
    • versionId required string: The version ID.
    • entityId required string: The entity ID.
    • roleId required string: The entity role ID.
    • entityRoleUpdateObject required EntityRoleUpdateObject

Output

Model_ListCustomPrebuiltIntents

Gets information about customizable prebuilt intents added to a version of the application.

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

Input

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

Output

Model_AddCustomPrebuiltIntent

Adds a customizable prebuilt intent model to a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_ListCustomPrebuiltModels

Gets all prebuilt intent and entity model information used in a version of this application.

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

Input

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

Output

Model_ListEntities

Gets information about all the simple entity models in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_AddEntity

Adds an entity extractor to a version of the application.

azure_cognitiveservices_luis_authoring.Model_AddEntity({
  "appId": "",
  "versionId": "",
  "entityModelCreateObject": {}
}, context)

Input

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

Output

Model_DeleteEntity

Deletes an entity or a child from a version of the application.

azure_cognitiveservices_luis_authoring.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 or the child entity extractor ID.

Output

Model_GetEntity

Gets information about an entity model in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_UpdateEntityChild

Updates the name of an entity extractor or the name and instanceOf model of a child entity extractor.

azure_cognitiveservices_luis_authoring.Model_UpdateEntityChild({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "entityModelUpdateObject": {}
}, context)

Input

  • input object
    • appId required string: The application ID.
    • versionId required string: The version ID.
    • entityId required string: The entity extractor or the child entity extractor ID.
    • entityModelUpdateObject required EntityModelUpdateObject

Output

Model_AddEntityChild

Creates a single child in an existing entity model hierarchy in a version of the application.

azure_cognitiveservices_luis_authoring.Model_AddEntityChild({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "childEntityModelCreateObject": {}
}, context)

Input

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

Output

Model_DeleteEntityFeature

Deletes a relation from the feature relations used by the entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_DeleteEntityFeature({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "featureRelationDeleteObject": {}
}, context)

Input

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

Output

Model_GetEntityFeatures

Gets the information of the features used by the entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_GetEntityFeatures({
  "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

Features_AddEntityFeature

Adds a new feature relation to be used by the entity in a version of the application.

azure_cognitiveservices_luis_authoring.Features_AddEntityFeature({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "featureRelationCreateObject": {}
}, context)

Input

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

Output

Model_ReplaceEntityFeatures

Updates the information of the features used by the entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_ReplaceEntityFeatures({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "featureRelationsUpdateObject": []
}, context)

Input

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

Output

Model_ListEntityRoles

Get all roles for an entity in a version of the application

azure_cognitiveservices_luis_authoring.Model_ListEntityRoles({
  "appId": "",
  "versionId": "",
  "entityId": ""
}, context)

Input

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

Output

Model_CreateEntityRole

Create an entity role in a version of the application.

azure_cognitiveservices_luis_authoring.Model_CreateEntityRole({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "entityRoleCreateObject": {}
}, context)

Input

  • input object
    • appId required string: The application ID.
    • versionId required string: The version ID.
    • entityId required string: The entity model ID.
    • entityRoleCreateObject required EntityRoleCreateObject

Output

Model_DeleteEntityRole

Delete an entity role in a version of the application.

azure_cognitiveservices_luis_authoring.Model_DeleteEntityRole({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "roleId": ""
}, context)

Input

  • input object
    • appId required string: The application ID.
    • versionId required string: The version ID.
    • entityId required string: The entity ID.
    • roleId required string: The entity role Id.

Output

Model_GetEntityRole

Get one role for a given entity in a version of the application

azure_cognitiveservices_luis_authoring.Model_GetEntityRole({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "roleId": ""
}, context)

Input

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

Output

Model_UpdateEntityRole

Update a role for a given entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_UpdateEntityRole({
  "appId": "",
  "versionId": "",
  "entityId": "",
  "roleId": "",
  "entityRoleUpdateObject": {}
}, context)

Input

  • input object
    • appId required string: The application ID.
    • versionId required string: The version ID.
    • entityId required string: The entity ID.
    • roleId required string: The entity role ID.
    • entityRoleUpdateObject required EntityRoleUpdateObject

Output

Model_ListEntitySuggestions

Get suggested example utterances that would improve the accuracy of the entity model in a version of the application.

azure_cognitiveservices_luis_authoring.Model_ListEntitySuggestions({
  "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

Examples_Add

Adds a labeled example utterance in a version of the application.

azure_cognitiveservices_luis_authoring.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

Examples_List

Returns example utterances to be reviewed from a version of the application.

azure_cognitiveservices_luis_authoring.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

Examples_Batch

Adds a batch of labeled example utterances to a version of the application.

azure_cognitiveservices_luis_authoring.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

Examples_Delete

Deletes the labeled example utterances with the specified ID from a version of the application.

azure_cognitiveservices_luis_authoring.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

Versions_Export

Exports a LUIS application to JSON format.

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

Input

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

Output

Features_List

Gets all the extraction phraselist and pattern features in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_ListHierarchicalEntities

Gets information about all the hierarchical entity models in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_DeleteHierarchicalEntity

Deletes a hierarchical entity from a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_GetHierarchicalEntity

Gets information about a hierarchical entity in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_UpdateHierarchicalEntity

Updates the name of a hierarchical entity model in a version of the application.

azure_cognitiveservices_luis_authoring.Model_UpdateHierarchicalEntity({
  "appId": "",
  "versionId": "",
  "hEntityId": "",
  "modelUpdateObject": {}
}, context)

Input

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

Output

Model_DeleteHierarchicalEntityChild

Deletes a hierarchical entity extractor child in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_GetHierarchicalEntityChild

Gets information about the child's model contained in an hierarchical entity child model in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_UpdateHierarchicalEntityChild

Renames a single child in an existing hierarchical entity model in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_ListHierarchicalEntityRoles

Get all roles for a hierarchical entity in a version of the application

azure_cognitiveservices_luis_authoring.Model_ListHierarchicalEntityRoles({
  "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

Model_CreateHierarchicalEntityRole

Create a role for an hierarchical entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_CreateHierarchicalEntityRole({
  "appId": "",
  "versionId": "",
  "hEntityId": "",
  "entityRoleCreateObject": {}
}, context)

Input

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

Output

Model_DeleteHierarchicalEntityRole

Delete a role for a given hierarchical role in a version of the application.

azure_cognitiveservices_luis_authoring.Model_DeleteHierarchicalEntityRole({
  "appId": "",
  "versionId": "",
  "hEntityId": "",
  "roleId": ""
}, context)

Input

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

Output

Model_GetHierarchicalEntityRole

Get one role for a given hierarchical entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_GetHierarchicalEntityRole({
  "appId": "",
  "versionId": "",
  "hEntityId": "",
  "roleId": ""
}, context)

Input

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

Output

Model_UpdateHierarchicalEntityRole

Update a role for a given hierarchical entity in a version of the application.

azure_cognitiveservices_luis_authoring.Model_UpdateHierarchicalEntityRole({
  "appId": "",
  "versionId": "",
  "hEntityId": "",
  "roleId": "",
  "entityRoleUpdateObject": {}
}, context)

Input

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

Output

Model_ListIntents

Gets information about the intent models in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_AddIntent

Adds an intent to a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_DeleteIntent

Deletes an intent from a version of the application.

azure_cognitiveservices_luis_authoring.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: If true, deletes the intent's example utterances. If false, moves the example utterances to the None intent. The default value is false.

Output

Model_GetIntent

Gets information about the intent model in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_UpdateIntent

Updates the name of an intent in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_DeleteIntentFeature

Deletes a relation from the feature relations used by the intent in a version of the application.

azure_cognitiveservices_luis_authoring.Model_DeleteIntentFeature({
  "appId": "",
  "versionId": "",
  "intentId": "",
  "featureRelationDeleteObject": {}
}, context)

Input

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

Output

Model_GetIntentFeatures

Gets the information of the features used by the intent in a version of the application.

azure_cognitiveservices_luis_authoring.Model_GetIntentFeatures({
  "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

Features_AddIntentFeature

Adds a new feature relation to be used by the intent in a version of the application.

azure_cognitiveservices_luis_authoring.Features_AddIntentFeature({
  "appId": "",
  "versionId": "",
  "intentId": "",
  "featureRelationCreateObject": {}
}, context)

Input

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

Output

Model_ReplaceIntentFeatures

Updates the information of the features used by the intent in a version of the application.

azure_cognitiveservices_luis_authoring.Model_ReplaceIntentFeatures({
  "appId": "",
  "versionId": "",
  "intentId": "",
  "featureRelationsUpdateObject": []
}, context)

Input

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

Output

Pattern_ListIntentPatterns

Returns patterns for the specific intent in a version of the application.

azure_cognitiveservices_luis_authoring.Pattern_ListIntentPatterns({
  "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.
    • 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

Model_ListIntentSuggestions

Suggests example utterances that would improve the accuracy of the intent model in a version of the application.

azure_cognitiveservices_luis_authoring.Model_ListIntentSuggestions({
  "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

Model_ListPrebuiltEntities

Gets all the available prebuilt entities in a version of the application.

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

Input

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

Output

Model_ListModels

Gets information about all the intent and entity models in a version of the application.

azure_cognitiveservices_luis_authoring.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

Model_Examples

Gets the example utterances for the given intent or entity model in a version of the application.

azure_cognitiveservices_luis_authoring.Model_Examples({
  "appId": "",
  "versionId": "",
  "modelId": ""
}, context)

Input

  • input object
    • appId required string: The application ID.
    • versionId required string: The version ID.
    • modelId required string: The ID (GUID) of the model.
    • 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

Model_ListPatternAnyEntityInfos

Get information about the Pattern.Any entity models in a version of the application.

azure_cognitiveservices_luis_authoring.Model_ListPatternAnyEntityInfos({
  "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

Model_CreatePatternAnyEntityModel

Adds a pattern.any entity extractor to a version of the application.

azure_cognitiveservices_luis_authoring.Model_CreatePatternAnyEntityModel({
  "appId": "",
  "versionId": "",
  "extractorCreateObject": {}
}, context)

Input

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

Output

Model_DeletePatternAnyEntityModel

Deletes a Pattern.Any entity extractor from a version of the application.

azure_cognitiveservices_luis_authoring.Model_DeletePatternAnyEntityModel({
  "appId": "",
  "versionId": "",
  "entityId": ""
}, context)

Input

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