Skip to content

Commit 1bf1393

Browse files
committed
added all screenshots, completed PII
1 parent b44b89f commit 1bf1393

File tree

26 files changed

+157
-61
lines changed

26 files changed

+157
-61
lines changed

articles/ai-services/language-service/key-phrase-extraction/how-to/call-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The key phrase extraction feature can evaluate unstructured text, and for each d
1919
This feature is useful if you need to quickly identify the main points in a collection of documents. For example, given input text "*The food was delicious and the staff was wonderful*", the service returns the main topics: "*food*" and "*wonderful staff*".
2020

2121
> [!TIP]
22-
> If you want to start using this feature, you can follow the [quickstart article](../quickstart.md) to get started. You can also make example requests using [Language Studio](../../language-studio.md) without needing to write code.
22+
> If you want to start using this feature, you can follow the [quickstart article](../quickstart.md) to get started. You can also make requests using [Azure AI Foundry](../../../../ai-studio//what-is-ai-studio.md) without needing to write code.
2323
2424
## Development options
2525

articles/ai-services/language-service/key-phrase-extraction/includes/development-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ To use key phrase extraction, you submit raw unstructured text for analysis and
1313

1414
|Development option |Description |
1515
|---------|---------|
16-
|Language studio | Language Studio is a web-based platform that lets you try entity linking with text examples without an Azure account, and your own data when you sign up. For more information, see the [Language Studio website](https://language.cognitive.azure.com/tryout/keyPhrases) or [language studio quickstart](../../language-studio.md). |
16+
|Azure AI Foundry | Azure AI Foundry is a web-based platform that lets you use entity linking with text examples with your own data when you sign up. For more information, see the [Azure AI Foundry website](https://ai.azure.com) or [Azure AI Foundry documentation](../../../../ai-studio/what-is-ai-studio.md). |
1717
|REST API or Client library (Azure SDK) | Integrate key phrase extraction into your applications using the REST API, or the client library available in a variety of languages. For more information, see the [key phrase extraction quickstart](../quickstart.md). |
1818
| Docker container | Use the available Docker container to [deploy this feature on-premises](../how-to/use-containers.md). These docker containers enable you to bring the service closer to your data for compliance, security, or other operational reasons. |
Loading
Loading

articles/ai-services/language-service/key-phrase-extraction/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,5 @@ An AI system includes not only the technology, but also the people who will use
3939
## Next steps
4040

4141
There are two ways to get started using the entity linking feature:
42-
* [Language Studio](../language-studio.md), which is a web-based platform that enables you to try several Azure AI Language features without needing to write code.
42+
* [Azure AI Foundry](../../../ai-studio/what-is-ai-studio.md.md) is a web-based platform that lets you to use several Azure AI Language features without needing to write code.
4343
* The [quickstart article](quickstart.md) for instructions on making requests to the service using the REST API and client library SDK.
402 KB
Loading
31.6 KB
Loading
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
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":::
Loading
Loading

0 commit comments

Comments
 (0)