botframework-sdk | Bot Framework provides the most comprehensive experience | Bot library

by microsoft JavaScript Version: 4.14.0 License: MIT

Download this library from

kandi X-RAY | botframework-sdk Summary

botframework-sdk is a JavaScript library typically used in Automation, Bot, Nodejs, Framework applications. botframework-sdk has no bugs, it has no vulnerabilities, it has a Permissive License and it has medium support. You can download it from GitHub.

Bot Framework provides the most comprehensive experience for building conversation applications. With the Bot Framework SDK, developers can build bots that converse free-form or with guided interactions including using simple text or rich cards that contain text, images, and action buttons. Developers can model and build sophisticated conversation using their favorite programming languages including C#, JS, Python and Java or using Bot Framework Composer, an open-source, visual authoring canvas for developers and multi-disciplinary teams to design and build conversational experiences with Language Understanding, QnA Maker and sophisticated composition of bot replies (Language Generation). Checkout the Bot Framework ecosystem section to learn more about other tooling and services related to the Bot Framework SDK.

Support

Quality

Security

License

Reuse

kandi-support Support

botframework-sdk has a medium active ecosystem.
It has 6706 star(s) with 2361 fork(s). There are 456 watchers for this library.
It had no major release in the last 12 months.
There are 147 open issues and 5478 have been closed. On average issues are closed in 73 days. There are 16 open pull requests and 0 closed requests.
It has a neutral sentiment in the developer community.
The latest version of botframework-sdk is 4.14.0

botframework-sdk Support

Best in #Bot

Average in #Bot

botframework-sdk Support

Best in #Bot

Average in #Bot

quality kandi Quality

botframework-sdk has 0 bugs and 0 code smells.

botframework-sdk Quality

Best in #Bot

Average in #Bot

botframework-sdk Quality

Best in #Bot

Average in #Bot

security Security

botframework-sdk has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.
botframework-sdk code analysis shows 0 unresolved vulnerabilities.
There are 0 security hotspots that need review.

botframework-sdk Security

Best in #Bot

Average in #Bot

botframework-sdk Security

Best in #Bot

Average in #Bot

license License

botframework-sdk is licensed under the MIT License. This license is Permissive.
Permissive licenses have the least restrictions, and you can use them in most projects.

botframework-sdk License

Best in #Bot

Average in #Bot

botframework-sdk License

Best in #Bot

Average in #Bot

build Reuse

botframework-sdk releases are available to install and integrate.
botframework-sdk saves you 111 person hours of effort in developing the same functionality from scratch.
It has 657 lines of code, 22 functions and 186 files.
It has high code complexity. Code complexity directly impacts maintainability of the code.

botframework-sdk Reuse

Best in #Bot

Average in #Bot

botframework-sdk Reuse

Best in #Bot

Average in #Bot

Top functions reviewed by kandi - BETA

kandi has reviewed botframework-sdk and discovered the below as its top functions. This is intended to give you an instant insight into botframework-sdk implemented functionality, and help decide if they suit your requirements.

Main entry point .
Resolve a static package version to npm
Synchronizes the resulting NPM files from the sourcerc folder to the source .
Executes a command
Install and install a package .
Get the npm path
Check if the script is installed .
Parse the name of the package specifier
Get the rush version
Removes the package to the install folder .

botframework-sdk Key Features

We track functional issues and features asks for the Bot Framework SDK, tools and Azure Bot Service in a variety of locations. If you have found an issue or have a feature request, please submit an issue to the below repositories.

botframework-sdk Examples and Code Snippets

See all related Code Snippets

Teams Bot - get credentials from Key Vault

Copy

Download

        var storageSecretValue = keyVaultClient.GetSecretAsync($"{this.configuration.GetSection("KeyVault")["BaseURL"]}{this.configuration["KeyVaultStrings:StorageConnection"]}");

Can't get imBack to work on Adaptive Cards that are set up to work with teams

Copy

Download

 "msteams": {
    "type": "imBack",
     "value": <value>
             }
       }

-----------------------

// For directline/webchat
"type": "Action.Submit",
"title": "Get Order Status",
"data": "Get Order Status"
},

// For MS Teams
"type": "Action.Submit",
"title": "Get Order Status",
"data": {
    "msteams": {
        "type": "imBack",
        "value": "Get Order Status"
    },
},

if (context.activity.channelId == 'meteams') {
    var menuCard = CardHelper.GetMenuCardTeams(cardOptions);
} else {
    var menuCard = CardHelper.GetMenuCard(cardOptions);
}

-----------------------

// For directline/webchat
"type": "Action.Submit",
"title": "Get Order Status",
"data": "Get Order Status"
},

// For MS Teams
"type": "Action.Submit",
"title": "Get Order Status",
"data": {
    "msteams": {
        "type": "imBack",
        "value": "Get Order Status"
    },
},

if (context.activity.channelId == 'meteams') {
    var menuCard = CardHelper.GetMenuCardTeams(cardOptions);
} else {
    var menuCard = CardHelper.GetMenuCard(cardOptions);
}

-----------------------

// For directline/webchat
"type": "Action.Submit",
"title": "Get Order Status",
"data": "Get Order Status"
},

// For MS Teams
"type": "Action.Submit",
"title": "Get Order Status",
"data": {
    "msteams": {
        "type": "imBack",
        "value": "Get Order Status"
    },
},

if (context.activity.channelId == 'meteams') {
    var menuCard = CardHelper.GetMenuCardTeams(cardOptions);
} else {
    var menuCard = CardHelper.GetMenuCard(cardOptions);
}

See all related Code Snippets

Community Discussions

Trending Discussions on botframework-sdk

The embeded Hyperlinks & Enlarge Image are not opening in Chrome Browser through MS-Teams Bot
Teams Bot - get credentials from Key Vault
Botframework not working Action Call in HeroCard
How to publish and deploy multi-channel bots without azure?
Connecting two bots with DirectLine javascript
Can't get imBack to work on Adaptive Cards that are set up to work with teams
Adaptive dialogs with Bot framework skills sample
How do i receive audio attachment sent by user to Bot?
Possible way to clear the conversation state at the end of a conversation for Microsoft Teams
with azure free trial account, can i deploy a bot to MS teams?

Trending Discussions on botframework-sdk

QUESTION

The embeded Hyperlinks & Enlarge Image are not opening in Chrome Browser through MS-Teams Bot

Asked 2022-Feb-16 at 14:41

The requirement is printing the FAQ ( QnA Maker result consider as an attachment in Adaptive Card Body ) contents in MS Team Bot ( HR Bot ). The core technology that we are using is C# with ASP.NET Core, Bot Framework SDK.

FAQ Bot Example:

User is asking payroll related details in MS Team Bot.
The response contains payroll document details ( Embedded as URL with bold or italic ).
All responses return as an attachment ( Adding this response in attachment in adaptivae card body and after that posting using send activity ).
AdaptiveCard version is 1.2

It's a FAQ bot and there are no code changes happening yet for the last two weeks. All these issues were encountered after the chrome latest updates ( Chrome updates).

We have tried the following scenario for the embedded hyperlink issue.

The Following answer hyperlink is opening on the MS-Teams app

Markdown Syntax in the QnA Maker

The Following answer is not opening on the MS-Teams app( embedded hyperlink is changed to Bold/Italic)

Answer Markdown Syntax in the QnA Maker

Note:

Opening MS teams bot in a Firefox Browser, then all scenarios are working.
Opening MS teams Bot in a Chrome Browser, then the second point is not working as I mentioned above
The detailed discussion on the same issue posted on github - expecting a quick fix because of customer need.

Enlarge Image Issue:

We are facing a similar issue mentioned in github.

ANSWER

Answered 2022-Feb-16 at 14:41

Adding answer from comment section for visibility:

We checked the embedded hyperlink issue in both Microsoft Teams Desktop client(Version 1.5.00.3276) and web client. The issue is fixed now.

Source https://stackoverflow.com/questions/70183481

QUESTION

Can't get imBack to work on Adaptive Cards that are set up to work with teams

Asked 2020-Sep-08 at 16:32

My bot has a menu card which I recently discovered doesn't work with teams. I want to use the imBack method to have the message show up in the chat. On their own, I can accomplish this with the following:

// For directline/webchat
"type": "Action.Submit",
"title": "Get Order Status",
"data": "Get Order Status"
},

// For MS Teams
"type": "Action.Submit",
"title": "Get Order Status",
"data": {
    "msteams": {
        "type": "imBack",
        "value": "Get Order Status"
    },
},

However, if I use the directline/webchat version, I get a general bot error in Teams (I believe the error is because the button doesn't create an imBack message, thus LUIS query is empty and all my code referencing LUIS attributes like topIntent and score fail. Due to bot design LUIS needs to be called every turn.) Likewise, if I use Teams version I get a general bot error in directline/webchat for the same reason. At first I tried to add additional objects like the one I created for msteams for other channel IDs, but that didn't change the behavior. Based on the information here, I was able to add the text attribute and copy it from context.activity.value to context.activity.text via the following:

// In my card definition
"type": "Action.Submit",
"title": "Get Order Status",
"data": {
    "msteams": {
        "type": "imBack",
        "value": "Get Order Status"
    },
    "text": "Get Order Status"
},

// In my onMessage handler
if (context.activity.channelData.postBack) {
    context.activity.text = context.activity.value.text;
}

When I implement it this way, it does technically work in both channels. However, the menu selection (in this case Get Order Status) does not appear in the chat window as a message from the user (and by extension, doesn't show in the chat transcript) for directline/webchat channel (it does for Teams channel). I would really like this to behave in the same way as it does if I just have the text at the attribute for data in my directline/webchat only implementation. Is there any way to set up the card (e.g. via different format of the data object to have different data sent based on channel) and/or onMessage handler so that, on button click, the text is displayed in the chat window regardless of channel, and by extension that text will go through LUIS so that I don't get bot errors due to null LUIS attributes?

The one thought I had was to create a separate card helper for Teams and call it from my menu intent based on channelId, but I'd like a more elegant solution than that if it is possible, especially since I have several different cards with submit buttons like this.

ANSWER

Answered 2020-Aug-21 at 19:35

If your card contains no inputs then I suspect you want a hero card and not an Adaptive Card. An imBack in a hero card will automatically work the way you want in both Web Chat and Teams. While Adaptive Cards are meant to adapt to the styles of their hosts, there is no builtin "imBack" feature of Adaptive Cards. String submit actions are a feature of Web Chat, and Bot Framework actions in Adaptive Cards are a feature of Teams. You're trying to get Adaptive Cards to do something that they can't do by themselves, and so you'll need to take your specific channel into consideration if you want to do that.

From this answer: How to rewrite a Adaptive Card Submit Action for MSTeams also working in Web Chat?

My blog post explains that if you want to use a string submit action you will need to do it differently in Web Chat and Teams: https://blog.botframework.com/2019/07/02/using-adaptive-cards-with-the-microsoft-bot-framework/

If you want to have the same submit action work the same way in both channels, it will need to be an object submit action. If you want a string submit action to work on both channels then your bot will need to check which channel the activity came from and react accordingly.

Source https://stackoverflow.com/questions/63497580

QUESTION

How do i receive audio attachment sent by user to Bot?

Asked 2020-May-11 at 22:14

I have added a step in Waterfall to get attachment from the user. When testing with BotFramework Emulator i am able to send audio file to the bot and echo back the same file again to the User.Below are the waterfall steps and the code

self.add_dialog(
        WaterfallDialog(
            WaterfallDialog.__name__,
            [
                self.project_step,
                self.name_step,
                self.description_step,
                **self.attachment_step**,
                self.confirm_step,
                self.final_step,
            ],
        )
    )

Below is the code for attachment step:

async def attachment_step(self, step_context: WaterfallStepContext) -> DialogTurnResult:
    confluence_details = step_context.options

    # Capture the results of the previous step
    confluence_details.description = step_context.result
    message_text = "please add an attachment"
    prompt_options = PromptOptions(
        prompt=MessageFactory.text(
            "add an attachment"
        ),
        retry_prompt=MessageFactory.text(
            "The attachment must be a mp4/wav audio file."
        ),
    )


    return await step_context.prompt(AttachmentPrompt.__name__, prompt_options)





async def confirm_step(
    self, step_context: WaterfallStepContext
) -> DialogTurnResult:

    confluence_details = step_context.options

    confluence_details.audioFile = (
        None if not step_context.result else step_context.result[0]
    )
    if confluence_details.audioFile:
            await step_context.context.send_activity(
                MessageFactory.attachment(
                    confluence_details.audioFile, "This is your audio file."
                )
            )

@staticmethod
async def file_prompt_validator(prompt_context: PromptValidatorContext) -> bool:
    if not prompt_context.recognized.succeeded:
        await prompt_context.context.send_activity(
            "No attachments received. Proceeding without attachment..."
        )

        # We can return true from a validator function even if recognized.succeeded is false.
        return True

    attachments = prompt_context.recognized.value

    valid_file = [
        attachment
        for attachment in attachments
        if attachment.content_type in ["audio/mp3", "audio/mp4","audio/wav"]
    ]

    prompt_context.recognized.value = valid_file

    # If none of the attachments are valid images, the retry prompt should be sent.
    return len(valid_file) > 0

The code works fine in emulator .

What i don't get is how do i send an audio file from User Application to bot? Can i send Audio file as base64 encoded string.If yes,what changes do i need to make at Bot's end.

I could find everywhere that file is to be sent in content URL that contains the URL of the location where file is hosted. I am unable to receive the file sent from the User Application to bot.

I am attaching a screenshot of conversation flow for reference.

Edit:- The previous issue was resolved. I was able to receive Audio file as Base64 encoded string.The issue was with the JSON being sent.In contentUrl it is supposed to be an array of attachments.My bad

Edit1:- When trying to send an audio file as base64 encoded string, It gives error for some file as:

{
    "error": {
        "code": "MessageSizeTooBig",
        "message": "Activity body too large for storage. Try using attachments to reduce the activity size."
    }
}

What does this actually mean?

As i could see from this link there is an upper limit on activity size. Could someone please suggest the most feasible way to send audio files to bot?

ANSWER

Answered 2020-May-11 at 22:14

When you get an error that says "message size too big," it means what it says. When it suggests that you use attachments, it means attachments that link to remote HTTP/HTTPS locations rather than embedding data. You should try uploading the uploading the file or using a service that's geared towards transferring audio like the Direct Line Speech channel.

Source https://stackoverflow.com/questions/61622335

QUESTION

Possible way to clear the conversation state at the end of a conversation for Microsoft Teams

Asked 2020-Apr-29 at 12:18

I'm creating a bot and every time the conversation end, I'll to clear the conversation state. For That I'm sending an activity with type endOfConversation after the last message.

At the method OnMessageActivityAsync of my bot I've added this code.

turnContext.OnSendActivities(OnSendActivitiesHandlerAsync);

Witch must execute this code:

private async Task<ResourceResponse[]> OnSendActivitiesHandlerAsync(ITurnContext turnContext, List<Activity> activities, Func<Task<ResourceResponse[]>> next)
{
    foreach (Activity activity in activities)
    {
        if (activity.Type == ActivityTypes.EndOfConversation)
        {
            await _conversationState.ClearStateAsync(turnContext); // <-- `_conversationState` is a global variable type of `BotState`.
        }
    }

    return await next();
}

It works very good in the Bot Framework Emulator, but when it goes live on Microsoft Teams I had errors. When looking for that message I've found this:

That particular type is not supported in Teams, sorry.

_{https://github.com/microsoft/botframework-sdk/issues/3300}

In the logs I see this when I want to send an endOfConversation type.

{
    "code": "BadArgument",
    "message": "Unknown activity type",
    "innerHttpError": null
}

I would to send an end of conversation type because based on that type I could clear the conversation state on the server side of the bot. In that state I store some objects that aren't not relevant anymore when the conversation is ended.

So my question is now how could I clear the conversation state at the end of an conversation without using the endOfConversation type?

ANSWER

Answered 2020-Apr-29 at 12:09

"RichMoe" in the link you've provided states that Teams does not support this operation (2017) and I think the same is still true - I don't think Teams has a concept of the "end" of a conversation, in the way that, for example, a support bot on a website would - like any conversation, Teams will try to keep the entire chat history forever.

Perhaps you can explain why you need to "end" the conversation, if there's something related I can try help with.

Source https://stackoverflow.com/questions/61501377