You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 30, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: docs/_docs/skills/handbook/add-skills-to-a-virtual-assistant.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,12 +46,13 @@ See the [Skills Overview]({{site.baseurl}}/overview/skills) section for details
46
46
47
47
Run the following command to add each Skill to your Virtual Assistant. This assumes you are running the CLI within the project directory and have created your Bot through the template and therefore have a `appsettings.json` file present in the working folder.
48
48
49
-
The `--luisFolder` parameter can be used to point the Skill CLI at the source LU files for trigger utterances. For Skills provided within this repo these can be found in the `Deployment/Resources/LU` folder of each Skill. The CLI will automatically traverse locale folder hierarchies. This can be omitted for any of the skills we provide as the LU files are provided locally. Also, you have to specify the `--cs` (for C#) or `--ts` (for TypeScript) argument for determining the coding language of your assistant, since each language takes different folder structures that need to be taken into consideration.
The `--luisFolder` parameter can be used to point the Skill CLI at the source LU files for trigger utterances. For Skills provided within this repo these can be found in the `Deployment/Resources/LU` folder of each Skill. The CLI will automatically traverse locale folder hierarchies. This can be omitted for any of the skills we provide as the LU files are provided locally. Also, you have to specify the `--cs` (for C#) or `--ts` (for TypeScript) argument for determining the coding language of your assistant, since each language takes different folder structures that need to be taken into consideration.
54
+
55
+
55
56
Once the connect command finish successfully, you can see under the `botFrameworkSkills` property of your Virtual Assistant's appsettings.json file that the following structure was added with the information provided in the Skill manifest.
56
57
57
58
```json
@@ -62,7 +63,7 @@ Once the connect command finish successfully, you can see under the `botFramewor
62
63
"name": "<SKILL_NAME>",
63
64
"description": "<SKILL_DESCRIPTION>"
64
65
},
65
-
"skillHostEndpoint": "<VA-SKILL_ENDPOINT>"
66
+
"skillHostEndpoint": "<VA_SKILL_ENDPOINT>"
66
67
```
67
68
68
69
See the [Skill CLI documentation]({{site.baseurl}}/skills/handbook/botskills) for detailed CLI documentation.
@@ -87,13 +88,14 @@ To update a Skill to your assistant/Bot we provide a `botskills` command line to
87
88
88
89
Run the following command to update a Skill to your Virtual Assistant. This assumes you are running the CLI within the project directory and have created your Bot through the template and therefore have a `appsettings.json` file present in the working folder.
89
90
90
-
The `--luisFolder` parameter can be used to point the Skill CLI at the source LU files for trigger utterances. For Skills provided within this repo these can be found in the `Deployment/Resources/LU` folder of each Skill. The CLI will automatically traverse locale folder hierarchies. This can be omitted for any of the skills we provide as the LU files are provided locally. Also, you have to specify the `--cs` (for C#) or `--ts` (for TypeScript) argument for determining the coding language of your assistant, since each language takes different folder structures that need to be taken into consideration.
The `--luisFolder` parameter can be used to point the Skill CLI at the source LU files for trigger utterances. For Skills provided within this repo these can be found in the `Deployment/Resources/LU` folder of each Skill. The CLI will automatically traverse locale folder hierarchies. This can be omitted for any of the skills we provide as the LU files are provided locally. Also, you have to specify the `--cs` (for C#) or `--ts` (for TypeScript) argument for determining the coding language of your assistant, since each language takes different folder structures that need to be taken into consideration.
96
+
96
97
## Refresh Connected Skills
98
+
97
99
To refresh the dispatch model with any changes made to connected skills use the following command, specifying the `--cs` (for C#) or `--ts` (for TypeScript) argument for determining the coding language of your assistant, since each language takes different folder structures that need to be taken into consideration.
Copy file name to clipboardExpand all lines: docs/_docs/skills/tutorials/create-skill/typescript/6-add-your-skill.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ order: 6
13
13
14
14
## Validate the Skill manifest endpoint
15
15
16
-
To validate your Skill is deployed and working open up a browser window and navigate to your deployed Skill manifest (`/api/skill/manifest endpoint`). e.g. `http://localhost:3978/api/skill/manifest`
16
+
To validate your Skill is deployed and working open up a browser window and navigate to your deployed Skill manifest. e.g. `http://localhost:3978/src/manifest/manifest-1.1.json`
17
17
18
18
## Adding your skill to an assistant
19
19
@@ -22,7 +22,7 @@ To add your new Skill to your assistant we provide the [botskills](https://www.n
22
22
Run the following command from a command prompt **within the directory of your assistant/Bot**.
-[List](./docs/commands/list.md) all Skills connected to your assistant
30
+
-[Migrate](./docs/commands/migrate.md) all the skills to the new schema configuration settings.
30
31
31
32
## Daily builds
32
33
Daily builds are based on the latest development code which means they may or may not be stable and probably won't be documented. These builds are better suited for more experienced users and developers although everyone is welcome to give them a shot and provide feedback.
| --cs | Determine your Virtual Assistant project structure to be a csharp-like structure |
50
50
| --ts | Determine your Virtual Assistant project structure to be a TypeScript-like structure |
51
-
| --noRefresh [true\|FALSE]| (OPTIONAL) Determine whether the model of your skills connected are not going to be refreshed (by default they are refreshed) |
51
+
| --noRefresh [true\|FALSE]| (OPTIONAL) Determine whether the model of your skills connected are not going to be refreshed (by default they are refreshed) |
52
+
| -e, --endpointName \<name> | (OPTIONAL) Name of the endpoint to connect to your assistant (case sensitive) (default to using the first endpoint) |
52
53
| --languages [languages]| (OPTIONAL) Comma separated list of locales used for LUIS culture (defaults to `en-us`) |
53
54
| --luisFolder [path]| (OPTIONAL) Path to the folder containing your Skills' '.lu' files (defaults to './deployment/resources/skills/en' inside your Virtual Assistant folder) |
54
-
| --dispatchFolder [path]| (OPTIONAL) Path to the folder containing your Virtual Assistant's `.dispatch` file (defaults to `./deployment/resources/dispatch` inside your Virtual Assistant folder) |
55
+
| --dispatchFolder [path]| (OPTIONAL) Path to the folder containing your Virtual Assistant's `.dispatch` file (defaults to `./deployment/resources/dispatch` inside your Virtual Assistant folder) |
55
56
| --outFolder [path]| (OPTIONAL) Path for any output file that may be generated (defaults to your Virtual Assistant's root folder) |
56
-
| --lgOutFolder [path]| (OPTIONAL) Path for the Luis Generate output (defaults to a 'service' folder inside your Virtual Assistant's folder) |
57
-
| --skillsFile [path]| (OPTIONAL) Path to your Virtual Assistant Skills configuration file (defaults to the `skills.json` inside your Virtual Assistant's folder) |
57
+
| --lgOutFolder [path]| (OPTIONAL) Path for the Luis Generate output (defaults to a 'service' folder inside your Virtual Assistant's folder) |
58
58
| --resourceGroup [name]| (OPTIONAL) Name of your Virtual Assistant's resource group in Azure (defaults to your Virtual Assistant's bot name) |
59
59
| --appSettingsFile [path]| (OPTIONAL) Path to your appsettings file (defaults to `appsettings.json` inside your Virtual Assistant's folder) |
60
60
| --cognitiveModelsFile [path]| (OPTIONAL) Path to your Cognitive Models file (defaults to `cognitivemodels.json` inside your Virtual Assistant's folder) |
@@ -64,13 +64,13 @@ For Skills that require other Authentication connection configuration please fol
64
64
An example on how to use it with a local Skill manifest file:
> **Note:** The paths to both the Skill Manifest and the Virtual Assistant Skills configuration file can be relative or absolute paths equally, and should be explicitly a `.json` file.
70
+
> **Note:** The paths to the Skill Manifest can be relative or absolute paths equally, and should be explicitly a `.json` file.
71
71
72
72
An example on how to use it with a remote Skill manifest:
| --ts | Determine your Virtual Assistant project structure to be a TypeScript-like structure |
20
20
| --noRefresh | (OPTIONAL) Determine whether the model of your skills connected are not going to be refreshed (by default they are refreshed) |
21
21
| --languages [languages]| (OPTIONAL) Comma separated list of locales used for LUIS culture (defaults to `en-us`) |
22
-
| --dispatchFolder [path]| (OPTIONAL) Path to the folder containing your Virtual Assistant's `.dispatch` file (defaults to `./deployment/resources/dispatch` inside your Virtual Assistant folder) |
22
+
| --dispatchFolder [path]| (OPTIONAL) Path to the folder containing your Virtual Assistant's `.dispatch` file (defaults to `./deployment/resources/dispatch` inside your Virtual Assistant folder) |
23
23
| --outFolder [path]| (OPTIONAL) Path for any output file that may be generated (defaults to your Virtual Assistant's root folder) |
24
-
| --lgOutFolder [path]| (OPTIONAL) Path for the Luis Generate output (defaults to a `service` folder inside your Virtual Assistant's folder) |
25
-
| --skillsFile[path]| (OPTIONAL) Path to your Virtual Assistant Skills configuration file (defaults to the `skills.json` inside your Virtual Assistant's folder) |
24
+
| --lgOutFolder [path]| (OPTIONAL) Path for the Luis Generate output (defaults to a `service` folder inside your Virtual Assistant's folder) |
25
+
| --appSettingsFile[path]| (OPTIONAL) Path to your app settings file (defaults to `appsettings.json` inside your assistant's folder)|
26
26
| --cognitiveModelsFile [path]| (OPTIONAL) Path to your Cognitive Models file (defaults to `cognitivemodels.json` inside your Virtual Assistant's folder) |
27
27
| --verbose | (OPTIONAL) Output detailed information about the processing of the tool |
| --appSettingsFile [path]| (OPTIONAL) Path to your appsettings file where the skills are stored (defaults to `appsettings.json` inside your Virtual Assistant's folder) |
17
-
| --verbose | (OPTIONAL) Output detailed information about the processing of the tool |
18
-
| -h, --help | Output usage information |
17
+
| --verbose | (OPTIONAL) Output detailed information about the processing of the tool |
| --sourceFile | (OPTIONAL) Path to your skills.json file, which contains the skills that will be migrated (defaults to `\skills.json\` inside your Virtual Assistant's folder) |
17
-
| --destFile | (OPTIONAL) (OPTIONAL) Path to your appsettings file. The skills information will be migrated to this file (defaults to `\appsettings.json\` inside your Virtual Assistant's folder) |
18
-
| --verbose | (OPTIONAL) Output detailed information about the processing of the tool |
| --sourceFile | (OPTIONAL) Path to your skills.json file, which contains the skills that will be migrated (defaults to `\skills.json\` inside your Virtual Assistant's folder) |
17
+
| --destFile | (OPTIONAL) Path to your appsettings file. The skills information will be migrated to this file (defaults to `\appsettings.json\` inside your Virtual Assistant's folder)|
18
+
| --verbose | (OPTIONAL) Output detailed information about the processing of the tool |
19
+
| -h, --help | Output usage information |
20
20
21
21
Here is an example of how to use the `Migrate` command:
22
22
23
-
> **Note:** The paths to both the Skill Manifest and the Virtual Assistant Skills configuration file can be relative or absolute paths equally, and should be explicitly a `.json` file.
0 commit comments