Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions lib/services/luis/authoring/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,24 @@ uid: azure-cognitiveservices-luis-authoring
summary: *content

---
# Microsoft Azure SDK for Node.js - LUISAuthoringClient
**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.**
## Microsoft Azure SDK for Node.js - LUISAuthoringClient

This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher**

## Features
### Features


## How to Install
### How to Install

```bash
npm install azure-cognitiveservices-luis-authoring
```

## How to use
### How to use

### Authentication, client creation and listPhraseLists features as an example.
#### Authentication, client creation, and listPhraseLists features as an example.

```javascript
const msRest = require("ms-rest");
Expand All @@ -31,14 +33,16 @@ const appId = ec7b1657-199d-4d8a-bbb2-89a11a42e02a;
const versionId = "testversionId";
const skip = 1;
const take = 1;

client.features.listPhraseLists(appId, versionId, skip, take).then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log('An error occurred:');
console.dir(err, {depth: null, colors: true});
});
```

## Related projects
### Related projects

- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node)
1 change: 1 addition & 0 deletions lib/services/luis/authoring/lib/lUISAuthoringClient.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ export default class LUISAuthoringClient extends ServiceClient {
train: operations.Train;
permissions: operations.Permissions;
pattern: operations.Pattern;
settings: operations.Settings;
}

export { LUISAuthoringClient, models as LUISAuthoringModels };
1 change: 1 addition & 0 deletions lib/services/luis/authoring/lib/lUISAuthoringClient.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ class LUISAuthoringClient extends ServiceClient {
this.train = new operations.Train(this);
this.permissions = new operations.Permissions(this);
this.pattern = new operations.Pattern(this);
this.settings = new operations.Settings(this);
this.models = models;
msRest.addSerializationMixin(this);
}
Expand Down
60 changes: 60 additions & 0 deletions lib/services/luis/authoring/lib/models/appVersionSettingObject.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
* regenerated.
*/

'use strict';

/**
* Object model of an application version setting.
*
*/
class AppVersionSettingObject {
/**
* Create a AppVersionSettingObject.
* @property {string} [name] The application version setting name.
* @property {string} [value] The application version setting value.
*/
constructor() {
}

/**
* Defines the metadata of AppVersionSettingObject
*
* @returns {object} metadata of AppVersionSettingObject
*
*/
mapper() {
return {
required: false,
serializedName: 'AppVersionSettingObject',
type: {
name: 'Composite',
className: 'AppVersionSettingObject',
modelProperties: {
name: {
required: false,
serializedName: 'name',
type: {
name: 'String'
}
},
value: {
required: false,
serializedName: 'value',
type: {
name: 'String'
}
}
}
}
};
}
}

module.exports = AppVersionSettingObject;
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@
class ApplicationCreateObject {
/**
* Create a ApplicationCreateObject.
* @member {string} culture The culture for the new application. It is the
* @property {string} culture 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.
* @member {string} [domain] The domain for the new application. Optional.
* @property {string} [domain] The domain for the new application. Optional.
* E.g.: Comics.
* @member {string} [description] Description of the new application.
* @property {string} [description] Description of the new application.
* Optional.
* @member {string} [initialVersionId] The initial version ID. Optional.
* @property {string} [initialVersionId] The initial version ID. Optional.
* Default value is: "0.1"
* @member {string} [usageScenario] Defines the scenario for the new
* @property {string} [usageScenario] Defines the scenario for the new
* application. Optional. E.g.: IoT.
* @member {string} name The name for the new application.
* @property {string} name The name for the new application.
*/
constructor() {
}
Expand Down
22 changes: 11 additions & 11 deletions lib/services/luis/authoring/lib/models/applicationInfoResponse.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,22 @@
class ApplicationInfoResponse {
/**
* Create a ApplicationInfoResponse.
* @member {uuid} [id] The ID (GUID) of the application.
* @member {string} [name] The name of the application.
* @member {string} [description] The description of the application.
* @member {string} [culture] The culture of the application. E.g.: en-us.
* @member {string} [usageScenario] Defines the scenario for the new
* @property {uuid} [id] The ID (GUID) of the application.
* @property {string} [name] The name of the application.
* @property {string} [description] The description of the application.
* @property {string} [culture] The culture of the application. E.g.: en-us.
* @property {string} [usageScenario] Defines the scenario for the new
* application. Optional. E.g.: IoT.
* @member {string} [domain] The domain for the new application. Optional.
* @property {string} [domain] The domain for the new application. Optional.
* E.g.: Comics.
* @member {number} [versionsCount] Amount of model versions within the
* @property {number} [versionsCount] Amount of model versions within the
* application.
* @member {string} [createdDateTime] The version's creation timestamp.
* @member {object} [endpoints] The Runtime endpoint URL for this model
* @property {string} [createdDateTime] The version's creation timestamp.
* @property {object} [endpoints] The Runtime endpoint URL for this model
* version.
* @member {number} [endpointHitsCount] Number of calls made to this
* @property {number} [endpointHitsCount] Number of calls made to this
* endpoint.
* @member {string} [activeVersion] The version ID currently marked as
* @property {string} [activeVersion] The version ID currently marked as
* active.
*/
constructor() {
Expand Down
13 changes: 2 additions & 11 deletions lib/services/luis/authoring/lib/models/applicationPublishObject.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,9 @@
class ApplicationPublishObject {
/**
* Create a ApplicationPublishObject.
* @member {string} [versionId] The version ID to publish.
* @member {boolean} [isStaging] Indicates if the staging slot should be
* @property {string} [versionId] The version ID to publish.
* @property {boolean} [isStaging] Indicates if the staging slot should be
* used, instead of the Production one. Default value: false .
* @member {string} [region] The target region that the application is
* published to.
*/
constructor() {
}
Expand Down Expand Up @@ -54,13 +52,6 @@ class ApplicationPublishObject {
type: {
name: 'Boolean'
}
},
region: {
required: false,
serializedName: 'region',
type: {
name: 'String'
}
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class ApplicationSettingUpdateObject {
/**
* Create a ApplicationSettingUpdateObject.
* @member {boolean} [publicProperty] Setting your application as public
* @property {boolean} [publicProperty] Setting your application as public
* allows other people to use your application's endpoint using their own
* keys.
*/
Expand Down
6 changes: 3 additions & 3 deletions lib/services/luis/authoring/lib/models/applicationSettings.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
class ApplicationSettings {
/**
* Create a ApplicationSettings.
* @member {uuid} id The application ID.
* @member {boolean} isPublic Setting your application as public allows other
* people to use your application's endpoint using their own keys.
* @property {uuid} id The application ID.
* @property {boolean} isPublic Setting your application as public allows
* other people to use your application's endpoint using their own keys.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class ApplicationUpdateObject {
/**
* Create a ApplicationUpdateObject.
* @member {string} [name] The application's new name.
* @member {string} [description] The application's new description.
* @property {string} [name] The application's new name.
* @property {string} [description] The application's new description.
*/
constructor() {
}
Expand Down
4 changes: 2 additions & 2 deletions lib/services/luis/authoring/lib/models/availableCulture.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class AvailableCulture {
/**
* Create a AvailableCulture.
* @member {string} [name] The language name.
* @member {string} [code] The ISO value for the language.
* @property {string} [name] The language name.
* @property {string} [code] The ISO value for the language.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
class AvailablePrebuiltEntityModel {
/**
* Create a AvailablePrebuiltEntityModel.
* @member {string} [name] The entity name.
* @member {string} [description] The entity description and usage
* @property {string} [name] The entity name.
* @property {string} [description] The entity description and usage
* information.
* @member {string} [examples] Usage examples.
* @property {string} [examples] Usage examples.
*/
constructor() {
}
Expand Down
14 changes: 7 additions & 7 deletions lib/services/luis/authoring/lib/models/batchLabelExample.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@
class BatchLabelExample {
/**
* Create a BatchLabelExample.
* @member {object} [value]
* @member {string} [value.utteranceText] The sample's utterance.
* @member {number} [value.exampleId] The newly created sample ID.
* @member {boolean} [hasError]
* @member {object} [error]
* @member {string} [error.code] Status Code. Possible values include:
* @property {object} [value]
* @property {string} [value.utteranceText] The sample's utterance.
* @property {number} [value.exampleId] The newly created sample ID.
* @property {boolean} [hasError]
* @property {object} [error]
* @property {string} [error.code] Status Code. Possible values include:
* 'Failed', 'FAILED', 'Success'
* @member {string} [error.message] Status details.
* @property {string} [error.message] Status details.
*/
constructor() {
}
Expand Down
4 changes: 2 additions & 2 deletions lib/services/luis/authoring/lib/models/childEntity.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class ChildEntity {
/**
* Create a ChildEntity.
* @member {uuid} id The ID (GUID) belonging to a child entity.
* @member {string} [name] The name of a child entity.
* @property {uuid} id The ID (GUID) belonging to a child entity.
* @property {string} [name] The name of a child entity.
*/
constructor() {
}
Expand Down
6 changes: 3 additions & 3 deletions lib/services/luis/authoring/lib/models/closedList.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
class ClosedList {
/**
* Create a ClosedList.
* @member {string} [name] Name of the closed list feature.
* @member {array} [subLists] Sublists for the feature.
* @member {array} [roles]
* @property {string} [name] Name of the closed list feature.
* @property {array} [subLists] Sublists for the feature.
* @property {array} [roles]
*/
constructor() {
}
Expand Down
20 changes: 10 additions & 10 deletions lib/services/luis/authoring/lib/models/closedListEntityExtractor.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@
class ClosedListEntityExtractor {
/**
* Create a ClosedListEntityExtractor.
* @member {uuid} id The ID of the Entity Model.
* @member {string} [name] Name of the Entity Model.
* @member {number} [typeId] The type ID of the Entity Model.
* @member {string} readableType Possible values include: 'Entity Extractor',
* 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor',
* 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt
* Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor',
* 'Regex Entity Extractor'
* @member {array} [roles]
* @member {array} [subLists] List of sub-lists.
* @property {uuid} id The ID of the Entity Model.
* @property {string} [name] Name of the Entity Model.
* @property {number} [typeId] The type ID of the Entity Model.
* @property {string} readableType Possible values include: 'Entity
* Extractor', 'Hierarchical Entity Extractor', 'Hierarchical Child Entity
* Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor',
* 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity
* Extractor', 'Regex Entity Extractor'
* @property {array} [roles]
* @property {array} [subLists] List of sub-lists.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class ClosedListModelCreateObject {
/**
* Create a ClosedListModelCreateObject.
* @member {array} [subLists] Sublists for the feature.
* @member {string} [name] Name of the closed list feature.
* @property {array} [subLists] Sublists for the feature.
* @property {string} [name] Name of the closed list feature.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class ClosedListModelPatchObject {
/**
* Create a ClosedListModelPatchObject.
* @member {array} [subLists] Sublists to add.
* @property {array} [subLists] Sublists to add.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class ClosedListModelUpdateObject {
/**
* Create a ClosedListModelUpdateObject.
* @member {array} [subLists] The new sublists for the feature.
* @member {string} [name] The new name of the closed list feature.
* @property {array} [subLists] The new sublists for the feature.
* @property {string} [name] The new name of the closed list feature.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class CollaboratorsArray {
/**
* Create a CollaboratorsArray.
* @member {array} [emails] The email address of the users.
* @property {array} [emails] The email address of the users.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class CompositeChildModelCreateObject {
/**
* Create a CompositeChildModelCreateObject.
* @member {string} [name]
* @property {string} [name]
*/
constructor() {
}
Expand Down
Loading