{"id":1175,"date":"2023-09-07T09:21:09","date_gmt":"2023-09-07T16:21:09","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/semantic-kernel\/?p=1175"},"modified":"2023-09-14T04:48:55","modified_gmt":"2023-09-14T11:48:55","slug":"evaluate-your-plugins-and-planners-with-prompt-flow","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/agent-framework\/evaluate-your-plugins-and-planners-with-prompt-flow\/","title":{"rendered":"Evaluate your plugins and planners with Prompt flow"},"content":{"rendered":"

\"Image<\/a><\/h2>\n

\"Image<\/a>As you build plugins<\/a> and add them to planners<\/a>, it’s important to make sure they work as intended. This becomes more important as you add more and more plugins to your planners. With more functions, your planners have a greater chance of hallucinating and doing incorrect things.<\/p>\n

Until now, testing your plugins and planners was a manual process that required you to individually test different user asks. While tools like Chat Copilot<\/a> can help, it is still a time consuming task. But what if you could automate testing and evaluation? With Prompt flow<\/a> you can!<\/p>\n

With our updated docs, we show you how you can create a new Prompt flow<\/a> with Semantic Kernel, run batch tests<\/a>, and run evaluations<\/a> to quantifiably measure the accuracy of your planners and plugins.<\/p>\n

Lastly, we also provide some tips<\/a> for using prompt engineering to improve the quality of your planners to get even better evaluation results. Below are some of the highlights of using Prompt flow with Semantic Kernel.<\/p>\n

Automate batch runs with Prompt flow.<\/h2>\n

Instead of manually testing different scenarios one-by-one, you can now automatically run large batches of tests using Prompt flow and benchmark data.<\/p>\n

In our updated docs<\/a>, we demonstrate how you can use this functionality to run batch tests on a planner that uses a math plugin. By defining a bunch of word problems<\/a>, we can quickly test any changes we make to our plugins or planners so we can catch regressions early and often.<\/p>\n

\"Image<\/a><\/p>\n

After defining our benchmark data and setting up the Prompt flow, you can easily run a batch test with the following command.<\/p>\n

pf run create --flow . --data data.jsonl --stream<\/code><\/pre>\n
Afterwards, you can view the results of your batch run directly within VS Code with the Prompt flow extension<\/a> to start investigating where the planner made mistakes.<\/p>\n
\"Image<\/a><\/p>\n
Quantify the accuracy of your planners.<\/h2>\n
After you’ve run a batch, you then need an easy way to see how many of the tests were “good enough”. With this information, you can start developing accuracy scores that you can try to improve over time.<\/p>\n
With evaluation flows<\/a>, you can do just that. With the sample evaluation flows provided by Prompt flow, you can measure classification accuracy<\/a>, perceived intelligence<\/a>, groundedness<\/a>, and more. You can even create your own custom evaluators<\/a> if you want!<\/p>\n
In the evaluation docs for Semantic Kernel, we demonstrate how to use the math accuracy evaluation flow<\/a>\u00a0to test our planner to see how well it solves word problems.<\/p>\n
\"Image<\/a><\/p>\n
After running the evaluator, you’ll get a summary back of your metrics. The first time you run it, you may get subpar results that you’ll want to immediately improve. For example, the math plugin in the docs initially only has an accuracy score of 60% and an error rate of 20%!<\/p>\n
We can definitely do better.<\/p>\n
\"Image<\/a><\/p>\n
Learn how to make your plugins and planners even better<\/em>.<\/h2>\n
If you find that your plugins and planners aren’t performing as well as they should, there are steps you can take to make them better. In the docs, we walkthrough a few concrete strategies you can take to make your plugins and planners better. At a high-level though, you should consider the following:<\/p>\n
    \n
  1. Use a more advanced model like GPT-4 instead of GPT-3.5-turbo.<\/li>\n
  2. Improve the description of your plugins<\/a> so they’re easier for the planner to use.<\/li>\n
  3. Inject additional help to the planner<\/a> when sending the user’s ask.<\/li>\n<\/ol>\n
    By doing a combination of these three things, we demonstrate how you can take a failing planner and turn it into a winning one! At the end of the walkthrough, you should have a planner that can correctly answer all of the benchmark data.<\/p>\n
    Follow along with our docs to get started!<\/h2>\n
    If you’re interested in learning more about how you can use Prompt flow to test and evaluate Semantic Kernel, we recommend following along to the new doc articles we created. At each step, we provide sample code and explanations so you can use Prompt flow successfully with Semantic Kernel.<\/p>\n\n\n\n\n\n\n\n
    Article<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
    Using Prompt flow with Semantic Kernel<\/a><\/td>\nLearn more about what Prompt flow is and why you would want to use it with Semantic Kernel.<\/td>\n<\/tr>\n
    Create a Prompt flow with Semantic Kernel<\/a><\/td>\nFollow the steps necessary to create a simple Prompt flow with Semantic Kernel at its core.<\/td>\n<\/tr>\n
    Running batches with Prompt flow<\/a><\/td>\nRun a suite of benchmark data on your new Prompt flow.<\/td>\n<\/tr>\n
    Evaluate your plugins and planners<\/a><\/td>\nEvaluate your plugins and planners and experiment with ways of improving them.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Keep an eye out for more integrations.<\/h2>\n
    The Prompt flow and Semantic Kernel teams aren’t done with adding more integrations. Keep an eye out for new integrations and reasons to use Prompt flow with Semantic Kernel over the coming weeks.<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"
    As you build plugins and add them to planners, it’s important to make sure they work as intended. This becomes more important as you add more and more plugins to your planners. With more functions, your planners have a greater chance of hallucinating and doing incorrect things. Until now, testing your plugins and planners was […]<\/p>\n","protected":false},"author":121401,"featured_media":1228,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-1175","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-semantic-kernel"],"acf":[],"blog_post_summary":"
    As you build plugins and add them to planners, it’s important to make sure they work as intended. This becomes more important as you add more and more plugins to your planners. With more functions, your planners have a greater chance of hallucinating and doing incorrect things. Until now, testing your plugins and planners was […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/posts\/1175","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/users\/121401"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/comments?post=1175"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/posts\/1175\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/media\/1228"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/media?parent=1175"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/categories?post=1175"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/tags?post=1175"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}