Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 3.77 KB

Installation.md

File metadata and controls

64 lines (43 loc) · 3.77 KB
Raw

Installation

Requirements

  • Windows 10
  • .Net Framework
  • WPF libraries

Installation process

You can fork the project in the github repository of SnipInsights.

Then navigate to the code location on your Windows 10 machine and double click the solution file SnipInsight.sln.

From there, select the C# project file SnipInsight.csproj. You should now be able to build and run the solution.

The next step to test the AI features is to generate API keys for each AI service (listed below). Go to the Azure portal, create an account or login if you already have one and generate API keys for each functionality you want to use.

To add the keys to Snip Insights, a Microsoft Garage Project, build and Start the application. Once running, click/tap the Settings icon in the toolbar. Scroll down until you find the "Cognitive Services, Enable AI assistance" toggle, and toggle it to the On position. You should now see the Insight Service Keys section.

  • Entity Search - Create new Entity Search Cognitive Service. Once created, you can display the keys. Select one and paste into "Settings"
  • Image Analysis - In Azure, create a **Computer Vision API ** Cognitive Service and use its key.
  • Image Search - In Azure, create a Bing Search v7 API Cognitive Service and use its key.
  • Text Recognition - You can use the same key as used in Image Analysis. Both Image Analysis and Text Recognition use Computer Vision API.
  • Translator - Use the Translator Text API Cognitive Service.
  • Content Moderator - Use the Content Moderator API Cognitive Service.

For the LUIS App ID and Key, you will need to create a Language Understanding application in the Language Understanding Portal (https://www.luis.ai) Use the following steps to create your LUIS App and retrieve an App ID

  • Click on Create new app button.
  • Provide an app name. Leave Culture (English) and Description as defaults.
  • Click Done
  • In the left navigation pane, click Entities
  • Click Manage prebuild entities
  • Select datetimeV2 and email
  • Click Done
  • Click the Train button at the top of the page
  • Click the Publish tab.
  • Click the Publish to production slot button
  • At the bottom of the screen you will see a list with a Key String field. Click the Copy button and paste that key value into the LUIS Key field in settings for Snip Insights
  • Click the Settings tab (at the top)
  • Copy the Application ID shown and paste into the LUIS App Id field in Settings for Snip Insights-

You can now paste each key in the settings panel of the application. Remember to Click the Save button after entering all the keys.

NOTE For each key entered there is a corresponding Service Endpoint. There are some default endpoints included (You can use as an example) but when you copy each key, also check and replace the Service Endpoint for each service you are using. You will find the service endpoint for each Cognitive Service on the Overview Page. Remember to Click the Save button after updating all the Service Endpoints.

Congratulations! You should now have a fully working application to get started. Have fun testing the project and thank you for your contribution!

Troubleshooting

No project is selected for compilation

Make sure you have selected the Debug configuration and are building the project correctly.

I can't run the project

You are most likely missing libraries. Right click on the SnipInsight project and select Install missing packages if that option is available.

I don't see the fields to paste my API keys on the settings panel

That is because you have not yet enabled AI assistance. Please enable it first and then enter your API keys.