|
1 | 1 | # ML Kit Entity Extraction Quickstart
|
2 | 2 |
|
3 |
| -The ML Kit Entity Extraction iOS Quickstart app demonstrates how to use the |
4 |
| -Entity Extraction feature of ML Kit to recognize structured data in |
5 |
| -text. |
| 3 | +* [Read more about ML Kit Entity Extraction API](https://developers.google.com/ml-kit/language/entity-extraction) |
6 | 4 |
|
7 | 5 | ## Introduction
|
8 | 6 |
|
9 |
| -TODO(mikie/bhaktipriya): add link to public docs. |
| 7 | +The ML Kit Entity Extraction iOS Quickstart app demonstrates how to use the ML |
| 8 | +Kit Entity Extraction feature to recognize structured data in text. |
| 9 | + |
| 10 | +This app requires network connectivity in order to download the corresponding |
| 11 | +language model. |
10 | 12 |
|
11 | 13 | ## Getting Started
|
12 | 14 |
|
13 |
| -- Needs XCode 11.3.1 or above. |
| 15 | +- Needs XCode 11.7 or above. |
14 | 16 | - Run the sample on your iOS device or simulator.
|
15 | 17 | - Type input text and change languages to see entity extraction in action.
|
16 | 18 |
|
| 19 | +## How to use the app |
| 20 | + |
| 21 | +- Enter text in the input box and hit "done" on your keyboard. |
| 22 | +- If any entities are found in the text, they will show up on the bottom half |
| 23 | +of the screen. |
| 24 | +- Click the "Models" button in the bottom right corner to ensure the correct |
| 25 | +language model has been downloaded. |
| 26 | + |
| 27 | +### Examples |
| 28 | + |
| 29 | +<table> |
| 30 | +<tr><th>Input text</th><th>Detected entities</th></tr> |
| 31 | + |
| 32 | +< tr>< td>You can contact the test team < b>tomorrow</ b> at < b> [email protected]</ b> |
| 33 | +to determine the best timeline.</td> |
| 34 | +<td>Entity 1 type: Date-Time<br> |
| 35 | +Entity 1 text: = "2020-12-09 00:00:00"<br><br> |
| 36 | + |
| 37 | +Entity 2 type: Email address<br> |
| 38 | +Entity 2 text: [email protected]</ td></ tr> |
| 39 | + |
| 40 | +<tr><td>Your order has shipped from Google. To follow the progress of your |
| 41 | +delivery please use this tracking number: <b>9612804152073070474837</b></td> |
| 42 | +<td>Entity type: Tracking number<br> |
| 43 | +Entity text: "FedEx 9612804152073070474837"</td></tr> |
| 44 | + |
| 45 | +<tr><td>Call the restaurant at <b>555-555-1234</b> to pay for dinner. My card |
| 46 | +number is <b>4111 1111 1111 1111</b>.</td> |
| 47 | +<td>Entity 1 type: Phone number<br> |
| 48 | +Entity 1 text: "555-555-1234"<br><br> |
| 49 | + |
| 50 | +Entity 2 type: Payment card<br> |
| 51 | +Entity 2 text: "Visa 4111 1111 1111 1111"</td></tr> |
| 52 | + |
| 53 | +</table> |
| 54 | + |
17 | 55 | ## Support
|
18 | 56 |
|
19 | 57 | - [Stack Overflow](https://stackoverflow.com/questions/tagged/google-mlkit)
|
|
0 commit comments