|
| 1 | +--- |
| 2 | +author: jboback |
| 3 | +manager: nitinme |
| 4 | +ms.service: azure-ai-language |
| 5 | +ms.topic: include |
| 6 | +ms.date: 02/16/2025 |
| 7 | +ms.author: jboback |
| 8 | +ms.custom: language-service-pii |
| 9 | +--- |
| 10 | + |
| 11 | +## Prerequisites |
| 12 | + |
| 13 | +* [Create a Project in Foundry in the Azure AI Foundry Portal](../../../../../ai-studio/how-to/create-projects?tabs=ai-studio.md) |
| 14 | + |
| 15 | +## Navigate to the Azure AI Foundry Playground |
| 16 | + |
| 17 | +Using the left side pane, select **Playgrounds**. Then select the **Try the Language Playground** button. |
| 18 | + |
| 19 | +:::image type="content" source="media/quickstarts/foundry/foundry-playground-navigation.png" alt-text="The development lifecycle" lightbox="media/quickstarts/foundry/foundry-playground-navigation.png"::: |
| 20 | + |
| 21 | +## Use NER in the Azure AI Foundry Playground |
| 22 | + |
| 23 | +The **Language Playground** consists of four sections: |
| 24 | + |
| 25 | +* Top banner: You can select any of the currently available Language services here. |
| 26 | +* Right pane: This pane is where you can find the **Configuration** options for the service, such as the API and model version, along with features specific to the service. |
| 27 | +* Center pane: This pane is where you enter your text for processing. After the operation is run, some results are shown here. |
| 28 | +* Right pane: This pane is where **Details** of the run operation are shown. |
| 29 | + |
| 30 | +Here you can select the Named Entity Recognition capability from the top banner tiles, **Extract Named Entities**. |
| 31 | + |
| 32 | +## Use Extract Named Entities |
| 33 | + |
| 34 | +**Extract Named Entities** is designed to identify named entities in text. |
| 35 | + |
| 36 | +In **Configuration** there are the following options: |
| 37 | + |
| 38 | +|Option |Description | |
| 39 | +|--------------------|-----------------------------------------| |
| 40 | +|Select API version | Select which version of the API to use. | |
| 41 | +|Select model version| Select which version of the model to use.| |
| 42 | +|Select text language| Select which language the language is input in.| |
| 43 | +|Select types to include| Select they types of information you want to extract.| |
| 44 | +|Overlap policy| Select the policy for overlapping entities.| |
| 45 | +|Inference options| Additional options to customize the return of the processed data.| |
| 46 | + |
| 47 | +After your operation is completed, the type of entity is displayed beneath each entity in the center pane and the **Details** section contains the following fields for each entity: |
| 48 | + |
| 49 | +|Field | Description | |
| 50 | +|------|----------------------------| |
| 51 | +|Entity|The detected entity.| |
| 52 | +|Category| The type of entity that was detected.| |
| 53 | +|Offset| The number of characters that the entity was detected from the beginning of the line.| |
| 54 | +|Length| The character length of the entity.| |
| 55 | +|Confidence| How confident the model is in the correctness of identification of entity's type.| |
| 56 | + |
| 57 | +:::image type="content" source="media/quickstarts/foundry/conversation-pii.png" alt-text="The development lifecycle" lightbox="media/quickstarts/foundry/conversation-pii.png"::: |
0 commit comments