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

[Feature Request]: Provide two new invoke handlers, (message/fetchTask, message/submitAction) for Custom Feedback Loops #2167

Closed
jk-msft opened this issue Nov 5, 2024 · 2 comments · Fixed by #2182
Assignees
Labels
enhancement New feature or request JS & dotnet & Python Change or fix must apply to all three programming languages medium tshirt size medium (5-10 days) P0

Comments

@jk-msft
Copy link

jk-msft commented Nov 5, 2024

Scenario

Overview

We currently allow Bot developers to receive feedback from Teams users using Feedback Loops. When a user clicks "Submit" the feedback, message/submitAction invoke is fired. We need a new invoke handler for message/submitAction invoke.

We are introducing Bot developers to create Custom feedback loops. These custom feedback loops allow Bot developers to show either an Adaptive Card (AC) task module or a website task module. If a bot sent a message with custom feedback loop enabled to the Teams client, the Teams client will fire new invoke, message/fetchTask to determine whether the custom feedback loop should show an AC task module or a website task module. We need another invoke handler for message/fetchTask invoke.

Example Screenshots

Default Feedback

Image

Custom Feedback (AC)

Image

Custom Feedback (Website)

Image

Solution

Provide invoke handlers for

  • message/submitAction
  • message/fetchTask

Return Values

How I am currently handling these two invokes inside onInvokeActivity

message/submitAction

{
  status: 200,
  body: {}
}

message/fetchTask

Adaptive Card

const taskModuleReturn = {  
  task: {  
    type: 'continue',  
    value: {  
      card: [Object], // Should contain valid Adaptive Card Payload 
      height: 200,  
      width: 400,  
      title: 'Test Task Module Title with AC'  
    }  
  }  
};
return {
  status: 200,
  body: taskModuleReturn
};

Website URL

const taskModuleReturn = {  
  task: {  
    type: 'continue',  
    value: {  
      url: "https://bing.com", // Should contain valid URL with the valid domain listed under App Manifest
    }  
  }  
};
return {
  status: 200,
  body: taskModuleReturn
};

Additional Context

Sample Bot Code

Send messages with feedback loop

    this.onMessage(async (context, next) => {
      console.log("Running with Message Activity.");
      const removedMentionText = TurnContext.removeRecipientMention(context.activity);
      const txt = removedMentionText.toLowerCase().replace(/\n|\r/g, "").trim();
      await context.sendActivity(`Echo: ${txt}`);
      await context.sendActivity({
        type: ActivityTypes.Message,
        text: "Old message with feedbackLoopEnabled = true",
        channelData: {
          feedbackLoopEnabled: true // use default feedback form
        },
      });
      await context.sendActivity({
        type: ActivityTypes.Message,
        text: "Old message with feedbackLoopEnabled = false",
        channelData: {
          feedbackLoopEnabled: false // use default feedback form
        },
      });
      await context.sendActivity({
        type: ActivityTypes.Message,
        text: "new message with feedbackLoop = default",
        channelData: {
          feedbackLoop: {
            type: "default"
          }
        },
      });
      await context.sendActivity({
        type: ActivityTypes.Message,
        text: "new message with feedbackLoop = custom",
        channelData: {
          feedbackLoop: {
            type: "custom"
          }
        },
      });
      // By calling next() you ensure that the next BotHandler is run.
      await next();
    });
@jk-msft jk-msft added the enhancement New feature or request label Nov 5, 2024
@jk-msft
Copy link
Author

jk-msft commented Nov 5, 2024

@aacebo
Copy link
Collaborator

aacebo commented Nov 7, 2024

@jk-msft thanks for the detailed submission! We intend to start working on this in the upcoming sprint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request JS & dotnet & Python Change or fix must apply to all three programming languages medium tshirt size medium (5-10 days) P0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants