Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add a doc to explain how to connect to a skill by http-based url or a .zip file #8279

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
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
Next Next commit
Create addskill.md
luhan2017 authored Jul 7, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 04ce62049b2e983292aebcb3e013d02f202d7abd
16 changes: 16 additions & 0 deletions docs/addskill.md
Original file line number Diff line number Diff line change
@@ -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
```