|
1 | 1 | --- |
2 | 2 | topic: sample |
3 | 3 | languages: |
4 | | - - C# |
| 4 | + - csharp |
5 | 5 | products: |
6 | 6 | - WPF |
7 | 7 | - azure |
8 | | - - windows |
9 | 8 | --- |
10 | 9 |
|
11 | | -# Ink Intelligence Cognitive Service C# WPF Sample |
| 10 | +# Ink Recogizer Cognitive Service C# WPF Sample |
12 | 11 |
|
13 | 12 |   |
14 | 13 |
|
15 | 14 | Ink Recognizer Cognitive Service provides recognition of digital ink. It takes the digital ink stroke data as input and provides a document tree with individual recognition units as output. This project has sample code to demonstrate a few ways developers can take advantage of the service. |
16 | 15 |
|
17 | 16 | ## Features |
18 | 17 |
|
19 | | -This project framework provides the following features: |
| 18 | +This sample provides the following features: |
20 | 19 |
|
21 | | -* Capturing very basic inking input. |
22 | | - |
23 | | -* Creating the JSON payload using the JSON schema used by Ink Recognizer. |
24 | | - |
25 | | -* Calling the Ink Recognizer REST APIs with the JSON payload |
26 | | - |
27 | | -* Parsing the JSON response from the service, build the document tree and parse it. |
| 20 | +* Collect ink strokes |
| 21 | +* Create JSON request following InkRecognizer service's schema. |
| 22 | +* Call the InkRecognizer REST API |
| 23 | +* Parse the JSON reponse to build the document tree |
28 | 24 |
|
29 | 25 | ## Contents |
30 | 26 |
|
31 | 27 | | File/folder | Description | |
32 | 28 | |-------------|-------------| |
33 | 29 | | `src` | Sample source code. | |
34 | | -| `.gitignore` | Define what to ignore at commit time. | |
35 | | -| `CHANGELOG.md` | List of changes to the sample. | |
36 | | -| `CONTRIBUTING.md` | Guidelines for contributing to the sample. | |
37 | 30 | | `README.md` | This README file. | |
38 | 31 | | `LICENSE` | The license for the sample. | |
39 | 32 |
|
40 | 33 | ## Getting Started |
41 | 34 |
|
42 | 35 | ### Prerequisites |
43 | 36 |
|
| 37 | +* Windows Build 1903 or higher |
44 | 38 | * [Visual Studio](https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio) |
45 | | -* Windows SDK Version >= 10.0.18362. You can install it from Visual Studio Installer under **Indivial components** tab, or download from [Windows Insider Preview SDK](https://www.microsoft.com/en-us/software-download/windowsinsiderpreviewSDK) |
46 | | - * If you install the Windows SDK into a customized path, please edit **src\NoteTaker.csproj** to change the HintPath of **Windows.winmd** to the correct path |
47 | | -* Requires subscription key from [Azure Cognitive Services](https://docs.microsoft.com/en-us/azure/cognitive-services/authentication) |
| 39 | +* Windows SDK Version >= 10.0.18362. You can install it from Visual Studio Installer under **Indivial components** tab, or download from [Windows 10 SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk) |
| 40 | + * If you install the Windows SDK into a customized path, please edit **src\NoteTaker.csproj** to change the HintPath of **Windows.winmd** to the correct path |
| 41 | +* Nuget Packages |
| 42 | + * [Newtonsoft.JSON](https://www.newtonsoft.com/json) |
| 43 | + * [Microsoft.Net.Http](https://www.nuget.org/packages/Microsoft.Net.Http/) |
| 44 | + * [Xaml Island for WPF](https://www.nuget.org/packages/Microsoft.Toolkit.Wpf.UI.Controls) |
| 45 | +* Requires subscription key from [Azure Cognitive Services](https://docs.microsoft.com/en-us/azure/cognitive-services/authentication) |
| 46 | + |
| 47 | +### Build the Sample |
| 48 | + |
| 49 | +1. Clone or download this sample repository `git clone https://github.com/Azure-Samples/cognitive-services-csharp-wpf-ink-recognition.git` |
| 50 | +2. Start Visual Studio and select **File > Open > Project/Solution** and open **src\NoteTaker.sln** |
| 51 | +3. Replace "[YOUR SUBSCRIPTION KEY]" in **src\MainWindows.xaml.cs** with valid subscription key |
| 52 | +4. Select **Build > Build Solution** |
| 53 | + |
| 54 | +### Run the sample |
48 | 55 |
|
49 | | -## Build the Sample |
| 56 | +* To debug the sample and then run it, select **Debug > Start Debugging**. To run the sample without debugging, select **Debug > Start Without Debugging**. |
| 57 | +* Write down something one the upper rectangle of the app |
| 58 | +* After one second of inactivity, the ink will be recognized and the result will be visible in the lower rectangle of the app |
50 | 59 |
|
51 | | -1. Clone or download this sample repository `git clone https://github.com/Azure-Samples/cognitive-services-csharp-wpf-ink-recognition.git` |
52 | | -2. Start Visual Studio and select **File > Open > Project/Solution** and open "NoteTaker.sln" |
53 | | -3. Replace "[YOUR SUBSCRIPTION KEY]" in MainWindows.xaml.cs with valid subscription key |
54 | | -4. Press Ctrl+Shift+B, or select **Build > Build Solution** |
| 60 | +## Resources |
55 | 61 |
|
56 | | -## Run the sample |
| 62 | +Additional resources related the project are located below |
57 | 63 |
|
58 | | -To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or select Debug > Start Without Debugging. |
| 64 | +* [Learn more about Ink Recognizer](http://go.microsoft.com/fwlink/?LinkID=2084782) |
| 65 | +* [Ink Recognizer API Reference](http://go.microsoft.com/fwlink/?LinkID=2085147) |
| 66 | +* [Ink Recognizer JavaScript sample](https://github.com/Azure-Samples/cognitive-services-REST-api-samples/tree/master/javascript/InkRecognition/javascript-app) |
| 67 | +* [Ink Recognizer UWP sample](https://github.com/Azure-Samples/cognitive-services-REST-api-samples/tree/master/dotnet/InkRecognition/uwp-app) |
| 68 | +* [Ink Recognizer Java sample](https://github.com/Azure-Samples/cognitive-services-REST-api-samples/tree/master/java/InkRecognition/android-sample-app) |
| 69 | +* [Ink Recognizer Swift sample](https://github.com/Azure-Samples/cognitive-services-REST-api-samples/tree/master/swift/InkRecognition) |
0 commit comments