Skip to content

Commit 11d2aa5

Browse files
authored
Merge pull request #2889 from jboback/pii-ner-ta4h-foundry-tab
Foundry Tab for PII, NER, TA4H, Language Detection, Summarization, Sentiment Analysis, Key Phrase Extraction quickstarts
2 parents 9712f96 + 4fc02cd commit 11d2aa5

File tree

53 files changed

+559
-53
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+559
-53
lines changed

articles/ai-services/language-service/entity-linking/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.devlang: csharp
1313
# ms.devlang: csharp, java, javascript, python
1414
ms.custom: language-service-entity-linking, mode-api, devx-track-extended-java, devx-track-js, devx-track-python
1515
keywords: text mining, entity linking
16-
zone_pivot_groups: programming-languages-text-analytics
16+
zone_pivot_groups: programming-languages-entity-linking
1717
---
1818

1919
# Quickstart: Entity Linking using the client library and REST API

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

Lines changed: 5 additions & 5 deletions
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

@@ -29,20 +29,20 @@ This feature is useful if you need to quickly identify the main points in a coll
2929

3030
### Specify the key phrase extraction model
3131

32-
By default, key phrase extraction will use the latest available AI model on your text. You can also configure your API requests to use a specific [model version](../../concepts/model-lifecycle.md).
32+
By default, key phrase extraction uses the latest available AI model on your text. You can also configure your API requests to use a specific [model version](../../concepts/model-lifecycle.md).
3333

3434
### Input languages
3535

36-
When you submit documents to be processed by key phrase extraction, you can specify which of [the supported languages](../language-support.md) they're written in. if you don't specify a language, key phrase extraction will default to English. The API may return offsets in the response to support different [multilingual and emoji encodings](../../concepts/multilingual-emoji-support.md).
36+
When you submit documents to be processed by key phrase extraction, you can specify which of [the supported languages](../language-support.md) they're written in. if you don't specify a language, key phrase extraction defaults to English. The API may return offsets in the response to support different [multilingual and emoji encodings](../../concepts/multilingual-emoji-support.md).
3737

3838
## Submitting data
3939

4040
Key phrase extraction works best when you give it bigger amounts of text to work on. This is opposite from sentiment analysis, which performs better on smaller amounts of text. To get the best results from both operations, consider restructuring the inputs accordingly.
4141

42-
To send an API request, You will need your Language resource endpoint and key.
42+
To send an API request, You need your Language resource endpoint and key.
4343

4444
> [!NOTE]
45-
> You can find the key and endpoint for your Language resource on the Azure portal. They will be located on the resource's **Key and endpoint** page, under **resource management**.
45+
> You can find the key and endpoint for your Language resource on the Azure portal. They are located on the resource's **Key and endpoint** page, under **resource management**.
4646
4747
Analysis is performed upon receipt of the request. Using the key phrase extraction feature synchronously is stateless. No data is stored in your account, and results are returned immediately in the response.
4848

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. |
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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+
---
9+
10+
## Prerequisites
11+
12+
* [Create a Project in Foundry in the Azure AI Foundry Portal](../../../../../ai-studio/how-to/create-projects.md)
13+
14+
## Navigate to the Azure AI Foundry Playground
15+
16+
Using the left side pane, select **Playgrounds**. Then select the **Try the Language Playground** button.
17+
18+
:::image type="content" source="../../media/quickstarts/azure-ai-foundry/foundry-playground-navigation.png" alt-text="The development lifecycle" lightbox="../../media/quickstarts/azure-ai-foundry/foundry-playground-navigation.png":::
19+
20+
## Use Key Phrase Extraction in the Azure AI Foundry Playground
21+
22+
The **Language Playground** consists of four sections:
23+
24+
* Top banner: You can select any of the currently available Language services here.
25+
* 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.
26+
* Center pane: This pane is where you enter your text for processing. After the operation is run, some results are shown here.
27+
* Right pane: This pane is where **Details** of the run operation are shown.
28+
29+
Here you can select the Key Phrase Extraction capability by choosing the top banner tile, **Extract key phrases**.
30+
31+
## Use Extract key phrases
32+
33+
**Extract key phrases** is designed to extract key phrases from text.
34+
35+
In **Configuration** there are the following options:
36+
37+
|Option |Description |
38+
|--------------------|-----------------------------------------|
39+
|Select API version | Select which version of the API to use. |
40+
|Select model version| Select which version of the model to use.|
41+
|Select text language| Select the language of the input text. |
42+
43+
After your operation is completed, each entity is underlined in the center pane and the **Details** section contains the following fields for the overall sentiment and the sentiment of each sentence:
44+
45+
|Field | Description |
46+
|------|----------------------------|
47+
|Extracted key phrases|A list of the extracted key phrases.|
48+
49+
:::image type="content" source="../../media/quickstarts/azure-ai-foundry/key-phrase-extraction.png" alt-text="A screenshot of an example of Extract key phrases in azure AI studio." lightbox="../../media/quickstarts/azure-ai-foundry/key-phrase-extraction.png":::
Loading
Loading

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ author: jboback
77
manager: nitinme
88
ms.service: azure-ai-language
99
ms.topic: overview
10-
ms.date: 09/27/2024
10+
ms.date: 02/17/2025
1111
ms.author: jboback
1212
ms.custom: language-service-key-phrase
1313
---
1414

1515
# What is key phrase extraction in Azure AI Language?
1616

17-
Key phrase extraction is one of the features offered by [Azure AI Language](../overview.md), a collection of machine learning and AI algorithms in the cloud for developing intelligent applications that involve written language. Use key phrase extraction to quickly identify the main concepts in text. For example, in the text "*The food was delicious and the staff were wonderful.*", key phrase extraction will return the main topics: "*food*" and "*wonderful staff*".
17+
Key phrase extraction is one of the features offered by [Azure AI Language](../overview.md), a collection of machine learning and AI algorithms in the cloud for developing intelligent applications that involve written language. Use key phrase extraction to quickly identify the main concepts in text. For example, in the text "*The food was delicious and the staff were wonderful.*", key phrase extraction returns the main topics: "*food*" and "*wonderful staff*."
1818

1919
This documentation contains the following types of articles:
2020

@@ -32,12 +32,12 @@ This documentation contains the following types of articles:
3232

3333
## Responsible AI
3434

35-
An AI system includes not only the technology, but also the people who will use it, the people who will be affected by it, and the environment in which it is deployed. Read the [transparency note for key phrase extraction](/legal/cognitive-services/language-service/transparency-note-key-phrase-extraction?context=/azure/ai-services/language-service/context/context) to learn about responsible AI use and deployment in your systems. You can also see the following articles for more information:
35+
An AI system includes not only the technology, but also the people who use it, the people who are affected by it, and the environment in which it's deployed. Read the [transparency note for key phrase extraction](/legal/cognitive-services/language-service/transparency-note-key-phrase-extraction?context=/azure/ai-services/language-service/context/context) to learn about responsible AI use and deployment in your systems. For more information, see the following articles:
3636

3737
[!INCLUDE [Responsible AI links](../includes/overview-responsible-ai-links.md)]
3838

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) is a web-based platform that lets you 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.

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: jboback
77
manager: nitinme
88
ms.service: azure-ai-language
99
ms.topic: quickstart
10-
ms.date: 11/21/2024
10+
ms.date: 02/17/2025
1111
ms.author: jboback
1212
ms.devlang: csharp
1313
# ms.devlang: csharp, java, javascript, python
@@ -48,6 +48,12 @@ zone_pivot_groups: programming-languages-text-analytics
4848

4949
::: zone-end
5050

51+
::: zone pivot="azure-ai-foundry"
52+
53+
[!INCLUDE [Azure AI Foundry quickstart](includes/quickstarts/azure-ai-foundry.md)]
54+
55+
::: zone-end
56+
5157
## Clean up resources
5258

5359
If you want to clean up and remove an Azure AI services subscription, you can delete the resource or resource group. Deleting the resource group also deletes any other resources associated with it.

articles/ai-services/language-service/language-detection/includes/development-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ To use language detection, you submit raw unstructured text for analysis and han
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/detectLanguage) 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 language detection into your applications using the REST API, or the client library available in a variety of languages. For more information, see the [language detection 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. |
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
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+
---
9+
10+
## Prerequisites
11+
12+
* [Create a Project in Foundry in the Azure AI Foundry Portal](../../../../../ai-studio/how-to/create-projects.md)
13+
14+
## Navigate to the Azure AI Foundry Playground
15+
16+
Using the left side pane, select **Playgrounds**. Then select the **Try the Language Playground** button.
17+
18+
:::image type="content" source="../../media/quickstarts/azure-ai-foundry/foundry-playground-navigation.png" alt-text="The development lifecycle" lightbox="../../media/quickstarts/azure-ai-foundry/foundry-playground-navigation.png":::
19+
20+
## Use Language Detection in the Azure AI Foundry Playground
21+
22+
The **Language Playground** consists of four sections:
23+
24+
* Top banner: You can select any of the currently available Language services here.
25+
* 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.
26+
* Center pane: This pane is where you enter your text for processing. After the operation is run, some results are shown here.
27+
* Right pane: This pane is where **Details** of the run operation are shown.
28+
29+
Here you can select the Language Detection capability by choosing the top banner tile, **Detect language**.
30+
31+
## Use Detect language
32+
33+
**Detect language** is designed to identify the language typed in text.
34+
35+
In **Configuration** there are the following options:
36+
37+
|Option |Description |
38+
|--------------------|-----------------------------------------|
39+
|Select API version | Select which version of the API to use. |
40+
|Select model version| Select which version of the model to use.|
41+
|Select country hint| Select the origin country of the input text. |
42+
43+
After your operation is completed, the **Details** section contains the following fields for the most detected language and script:
44+
45+
|Field | Description |
46+
|------|----------------------------|
47+
|Sentence|
48+
|Iso 639-1 Code| The ISE 639-1 code for the most detected language.|
49+
|Confidence Score| How confident the model is in the correctness of identification of the most typed language.|
50+
|Script Name| The name of the most detected script in the text.
51+
|Iso 15924 Script Code| The ISO 15924 script code for the most detected script.|
52+
53+
:::image type="content" source="../../media/quickstarts/azure-ai-foundry/language-detection.png" alt-text="A screenshot of an example of detect language in azure AI studio." lightbox="../../media/quickstarts/azure-ai-foundry/language-detection.png":::

0 commit comments

Comments
 (0)