From 04ce62049b2e983292aebcb3e013d02f202d7abd Mon Sep 17 00:00:00 2001 From: Lu Han <32191031+luhan2017@users.noreply.github.com> Date: Wed, 7 Jul 2021 14:58:13 +0800 Subject: [PATCH 1/4] Create addskill.md --- docs/addskill.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/addskill.md diff --git a/docs/addskill.md b/docs/addskill.md new file mode 100644 index 0000000000..ab8dc338e6 --- /dev/null +++ b/docs/addskill.md @@ -0,0 +1,16 @@ +# How to connect to a skill + +In the Bot Framework Composer, you can "connect to a skill" by providing a manifest file and coreponding dispatch models. +- The manifest json could be either v2.0 or v2.1 or v2.2. Note: Only v2.2 supports url-reference for dispatch models, https://github.com/microsoft/botframework-sdk/blob/main/schemas/skills/v2.2/skill-manifest.json +- The "connect to a skill" action will be success as long as the manifest file content is valid. If the absolute/relative url is not accessible, you will just get an warning, and you can continue to edit your trigger phrases and add the skill. + +## The manifest file could be provided in two ways + +- A http-based manifest url. In the manifest, the url could be an absolute http url, or a relative file path which can be resolved to a http url. +``` + For example: https://yourazurewebapp.azurewebsites.net/manifests/CoreAssistant-2-1-manifest.json +``` +- A .zip file with manifest.json and the dispatch models(.lu .qna...). If it is v2.2. The privacyUrl, the iconUrl and the dispatch models urls can all be relative url within the .zip folder. +``` + For example: https://github.com/microsoft/botframework-sdk/tree/main/schemas/skills/v2.2/samples/relativeUris +``` From 13bf9e13dfd6f6b91bfd1638b9e80fdb116d4318 Mon Sep 17 00:00:00 2001 From: Lu Han <32191031+luhan2017@users.noreply.github.com> Date: Wed, 7 Jul 2021 16:30:16 +0800 Subject: [PATCH 2/4] Update addskill.md --- docs/addskill.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/docs/addskill.md b/docs/addskill.md index ab8dc338e6..daf7b91613 100644 --- a/docs/addskill.md +++ b/docs/addskill.md @@ -1,16 +1,25 @@ # How to connect to a skill -In the Bot Framework Composer, you can "connect to a skill" by providing a manifest file and coreponding dispatch models. -- The manifest json could be either v2.0 or v2.1 or v2.2. Note: Only v2.2 supports url-reference for dispatch models, https://github.com/microsoft/botframework-sdk/blob/main/schemas/skills/v2.2/skill-manifest.json -- The "connect to a skill" action will be success as long as the manifest file content is valid. If the absolute/relative url is not accessible, you will just get an warning, and you can continue to edit your trigger phrases and add the skill. +In Bot framework composer, you can "connect to a skill" by providing a http-based manifest URL or a local compressed (.zip) file. -## The manifest file could be provided in two ways +- The http-based manifest URL should be accessible and a valid manifest JSON file. Otherwise, "connect to a skill" will be failed. +- The local compressed file should include one and only one valid manifest JSON file and corresponding language file if needed. -- A http-based manifest url. In the manifest, the url could be an absolute http url, or a relative file path which can be resolved to a http url. +For manifest version, Composer support manifest v2.0, v2.1 and v2.2. +- Manifest v2.0 +- Manifest v2.1 - support dispatch modal +- Manifest v2.2 - support uri-reference in privacyUrl, iconUrl and language dispatch modal + +Examples: +1. A http-based manifest url ``` - For example: https://yourazurewebapp.azurewebsites.net/manifests/CoreAssistant-2-1-manifest.json + https://github.com/microsoft/botframework-sdk/blob/main/schemas/skills/v2.1/samples/complex-skillmanifest.json ``` -- A .zip file with manifest.json and the dispatch models(.lu .qna...). If it is v2.2. The privacyUrl, the iconUrl and the dispatch models urls can all be relative url within the .zip folder. + +2. A .zip file (Download all the folders and files under relativeUris and zip it) ``` - For example: https://github.com/microsoft/botframework-sdk/tree/main/schemas/skills/v2.2/samples/relativeUris + https://github.com/microsoft/botframework-sdk/tree/main/schemas/skills/v2.2/samples/relativeUris ``` + + + From 9ea0454a4c07215546d96fbc7c1712d6b95c2f7e Mon Sep 17 00:00:00 2001 From: Lu Han <32191031+luhan2017@users.noreply.github.com> Date: Wed, 7 Jul 2021 16:45:04 +0800 Subject: [PATCH 3/4] Update addskill.md --- docs/addskill.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/addskill.md b/docs/addskill.md index daf7b91613..89faff6328 100644 --- a/docs/addskill.md +++ b/docs/addskill.md @@ -16,7 +16,15 @@ Examples: https://github.com/microsoft/botframework-sdk/blob/main/schemas/skills/v2.1/samples/complex-skillmanifest.json ``` -2. A .zip file (Download all the folders and files under relativeUris and zip it) +2. A .zip file usually contains +- (required) a manifest json. (User will get an error if no manifest or multiple manifests found in the zip) +- (optional) dispatch models. (.lu or .qna files) +- (optional) privacy file. +- (optional) icon file. + +If the manifest.json is v2.2, dispatch models, privacy file and icon file can all be a relative path in the manifest.json + +See more details in the following example. ``` https://github.com/microsoft/botframework-sdk/tree/main/schemas/skills/v2.2/samples/relativeUris ``` From 0c3894a412615184401546aa99545689e349643e Mon Sep 17 00:00:00 2001 From: Lu Han <32191031+luhan2017@users.noreply.github.com> Date: Wed, 7 Jul 2021 16:57:23 +0800 Subject: [PATCH 4/4] Update addskill.md --- docs/addskill.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/addskill.md b/docs/addskill.md index 89faff6328..3631b834fb 100644 --- a/docs/addskill.md +++ b/docs/addskill.md @@ -6,23 +6,23 @@ In Bot framework composer, you can "connect to a skill" by providing a http-base - The local compressed file should include one and only one valid manifest JSON file and corresponding language file if needed. For manifest version, Composer support manifest v2.0, v2.1 and v2.2. -- Manifest v2.0 -- Manifest v2.1 - support dispatch modal -- Manifest v2.2 - support uri-reference in privacyUrl, iconUrl and language dispatch modal +- Manifest v2.0. +- Manifest v2.1 - support dispatch modal. +- Manifest v2.2 - support uri-reference in privacyUrl, iconUrl and language dispatch modal. Examples: -1. A http-based manifest url +1. A http-based manifest url. ``` https://github.com/microsoft/botframework-sdk/blob/main/schemas/skills/v2.1/samples/complex-skillmanifest.json ``` -2. A .zip file usually contains +2. A .zip file usually contains - (required) a manifest json. (User will get an error if no manifest or multiple manifests found in the zip) - (optional) dispatch models. (.lu or .qna files) - (optional) privacy file. - (optional) icon file. -If the manifest.json is v2.2, dispatch models, privacy file and icon file can all be a relative path in the manifest.json +If the manifest.json is v2.2, dispatch models, privacy file and icon file can all be a relative path in the manifest.json. See more details in the following example. ```