Skip to content

Commit 5a6cf46

Browse files
committed
PR fixes
1 parent 434eabf commit 5a6cf46

File tree

5 files changed

+15
-20
lines changed

5 files changed

+15
-20
lines changed

articles/ai-services/content-safety/includes/quickstarts/rest-quickstart-custom-categories.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.author: pafarley
1212
## Prerequisites
1313

1414
* An Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services/)
15-
* Once you have your Azure subscription, <a href="https://aka.ms/acs-create" title="Create a Content Safety resource" target="_blank">create a Content Safety resource</a> in the Azure portal to get your key and endpoint. Enter a unique name for your resource, select your subscription, and select a resource group, [supported region](./overview.md#region-availability), and supported pricing tier. Then select **Create**.
15+
* Once you have your Azure subscription, <a href="https://aka.ms/acs-create" title="Create a Content Safety resource" target="_blank">create a Content Safety resource</a> in the Azure portal to get your key and endpoint. Enter a unique name for your resource, select your subscription, and select a resource group, [supported region](../overview.md#region-availability), and supported pricing tier. Then select **Create**.
1616
* The resource takes a few minutes to deploy. After it finishes, Select **go to resource**. In the left pane, under **Resource Management**, select **Subscription Key and Endpoint**. Copy the endpoint and either of the key values to a temporary location for later use.
1717
* Also [create an Azure blob storage container](https://ms.portal.azure.com/#create/Microsoft.StorageAccount-ARM) where you'll keep your training annotation file.
1818
* One of the following installed:
@@ -25,7 +25,7 @@ ms.author: pafarley
2525
To train a custom category, you need example text data that represents the category you want to detect. In this guide, you can use sample data. The provided annotation file contains text prompts about survival advice in camping/wilderness situations. The trained model will learn to detect this type of content in new text data.
2626

2727
> [!TIP]
28-
> For tips on creating your own data set, see the [How-to guide](./how-to/custom-categories.md#prepare-your-training-data).
28+
> For tips on creating your own data set, see the [How-to guide](../how-to/custom-categories.md#prepare-your-training-data).
2929
3030
1. Download the [sample text data file](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/ContentSafety/survival-advice.jsonl) from the GitHub repository.
3131
1. Upload the _.jsonl_ file to your Azure Storage account blob container. Then copy the blob URL to a temporary location for later use.
@@ -36,7 +36,7 @@ For example, your blob URL cannot be split into two layers, such as example/exam
3636
>
3737
### Grant storage access
3838

39-
[!INCLUDE [storage-account-access](./includes/storage-account-access.md)]
39+
[!INCLUDE [storage-account-access](../storage-account-access.md)]
4040

4141
## Create and train a custom category
4242

articles/ai-services/content-safety/includes/quickstarts/rest-quickstart-groundedness.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ ms.author: pafarley
1414
## Prerequisites
1515

1616
* An Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services/)
17-
* Once you have your Azure subscription, <a href="https://aka.ms/acs-create" title="Create a Content Safety resource" target="_blank">create a Content Safety resource </a> in the Azure portal to get your key and endpoint. Enter a unique name for your resource, select your subscription, and select a resource group, [supported region](./overview.md#region-availability), and supported pricing tier. Then select **Create**.
17+
* Once you have your Azure subscription, <a href="https://aka.ms/acs-create" title="Create a Content Safety resource" target="_blank">create a Content Safety resource </a> in the Azure portal to get your key and endpoint. Enter a unique name for your resource, select your subscription, and select a resource group, [supported region](../overview.md#region-availability), and supported pricing tier. Then select **Create**.
1818
* The resource takes a few minutes to deploy. After it does, go to the new resource. In the left pane, under **Resource Management**, select **API Keys and Endpoints**. Copy one of the subscription key values and endpoint to a temporary location for later use.
1919
* (Optional) If you want to use the _reasoning_ feature, create an Azure OpenAI Service resource with a GPT model deployed.
2020
* [cURL](https://curl.haxx.se/) or [Python](https://www.python.org/downloads/) installed.
2121

2222
## Authentication
23-
For enhanced security, you need to use Managed Identity (MI) to manage access to your resources, for more details, please refer to [Security](./overview.md#security).
23+
For enhanced security, you need to use Managed Identity (MI) to manage access to your resources, for more details, please refer to [Security](../overview.md#security).
2424

2525
## Check groundedness without reasoning
2626

@@ -130,7 +130,7 @@ The parameters in the request body are defined in this table:
130130
| **qna** | (Optional) Holds QnA data when the task type is `QnA`. | String |
131131
| - `query` | (Optional) This represents the question in a QnA task. Character limit: 7,500. | String |
132132
| **text** | (Required) The LLM output text to be checked. Character limit: 7,500. | String |
133-
| **groundingSources** | (Required) Uses an array of grounding sources to validate AI-generated text. See [Input requirements](./overview.md#input-requirements) for limits. | String array |
133+
| **groundingSources** | (Required) Uses an array of grounding sources to validate AI-generated text. See [Input requirements](../overview.md#input-requirements) for limits. | String array |
134134
| **reasoning** | (Optional) Specifies whether to use the reasoning feature. The default value is `false`. If `true`, you need to bring your own Azure OpenAI GPT4o (0513, 0806 version) to provide an explanation. Be careful: using reasoning increases the processing time.| Boolean |
135135
136136
### Interpret the API response
@@ -287,7 +287,7 @@ The parameters in the request body are defined in this table:
287287
| **qna** | (Optional) Holds QnA data when the task type is `QnA`. | String |
288288
| - `query` | (Optional) This represents the question in a QnA task. Character limit: 7,500. | String |
289289
| **text** | (Required) The LLM output text to be checked. Character limit: 7,500. | String |
290-
| **groundingSources** | (Required) Uses an array of grounding sources to validate AI-generated text. See [Input requirements](./overview.md#input-requirements) for limits, | String array |
290+
| **groundingSources** | (Required) Uses an array of grounding sources to validate AI-generated text. See [Input requirements](../overview.md#input-requirements) for limits, | String array |
291291
| **reasoning** | (Optional) Set to `true`, the service uses Azure OpenAI resources to provide an explanation. Be careful: using reasoning increases the processing time and incurs extra fees.| Boolean |
292292
| **llmResource** | (Required) If you want to use your own Azure OpenAI GPT4o (0513, 0806 version) resource to enable reasoning, add this field and include the subfields for the resources used. | String |
293293
| - `resourceType `| Specifies the type of resource being used. Currently it only allows `AzureOpenAI`. We only support Azure OpenAI GPT4o (0513, 0806 version) resources and do not support other GPT types. | Enum|
@@ -441,7 +441,7 @@ The parameters in the request body are defined in this table:
441441
| **qna** | (Optional) Holds QnA data when the task type is `QnA`. | String |
442442
| - `query` | (Optional) This represents the question in a QnA task. Character limit: 7,500. | String |
443443
| **text** | (Required) The LLM output text to be checked. Character limit: 7,500. | String |
444-
| **groundingSources** | (Required) Uses an array of grounding sources to validate AI-generated text. See [Input requirements](./overview.md#input-requirements) for limits. | String Array |
444+
| **groundingSources** | (Required) Uses an array of grounding sources to validate AI-generated text. See [Input requirements](../overview.md#input-requirements) for limits. | String Array |
445445
| **correction** | (Optional) Set to `true`, the service uses Azure OpenAI resources to provide the corrected text, ensuring consistency with the grounding sources. Be careful: using correction increases the processing time and incurs extra fees.| Boolean |
446446
| **llmResource** | (Required) If you want to use your own Azure OpenAI GPT4o (0513, 0806 version) resource to enable reasoning, add this field and include the subfields for the resources used. | String |
447447
| - `resourceType `| Specifies the type of resource being used. Currently it only allows `AzureOpenAI`. We only support Azure OpenAI GPT4o (0513, 0806 version) resources and do not support other GPT types. | Enum|

articles/ai-services/content-safety/includes/quickstarts/rest-quickstart-protected-material-code.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The following section walks through a sample request with cURL. Paste the comman
2525
1. Replace `<your_subscription_key>` with one of the keys that come with your resource.
2626
1. Optionally, replace the `"code"` field in the body with your own Code you'd like to analyze.
2727
> [!TIP]
28-
> See [Input requirements](./overview.md#input-requirements) for maximum Code length limitations. Protected material detection is meant to be run on LLM completions, not user prompts.
28+
> See [Input requirements](../overview.md#input-requirements) for maximum Code length limitations. Protected material detection is meant to be run on LLM completions, not user prompts.
2929
3030
```shell
3131
curl --location --request POST '<endpoint>/contentsafety/text:detectProtectedMaterialForCode?api-version=2024-09-15-preview' \
@@ -95,11 +95,6 @@ The JSON fields in the output are defined here:
9595

9696
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.
9797

98-
- [Azure portal](../multi-service-resource.md?pivots=azportal#clean-up-resources)
99-
- [Azure CLI](../multi-service-resource.md?pivots=azcli#clean-up-resources)
98+
- [Azure portal](../../multi-service-resource.md?pivots=azportal#clean-up-resources)
99+
- [Azure CLI](../../multi-service-resource.md?pivots=azcli#clean-up-resources)
100100

101-
102-
## Related content
103-
104-
* [Protected material detection concepts](./concepts/protected-material.md)
105-
* Configure filters for each category and test on datasets using [Content Safety Studio](studio-quickstart.md), export the code and deploy.

articles/ai-services/content-safety/includes/quickstarts/rest-quickstart-protected-material-text.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The following section walks through a sample request with cURL. Paste the comman
2525
1. Replace `<your_subscription_key>` with one of the keys that come with your resource.
2626
1. Optionally, replace the `"text"` field in the body with your own text you'd like to analyze.
2727
> [!TIP]
28-
> See [Input requirements](./overview.md#input-requirements) for maximum text length limitations. Protected material detection is meant to be run on LLM completions, not user prompts.
28+
> See [Input requirements](../overview.md#input-requirements) for maximum text length limitations. Protected material detection is meant to be run on LLM completions, not user prompts.
2929
3030
```shell
3131
curl --location --request POST '<endpoint>/contentsafety/text:detectProtectedMaterial?api-version=2024-09-01' \
@@ -79,5 +79,5 @@ The JSON fields in the output are defined here:
7979
8080
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.
8181
82-
- [Azure portal](../multi-service-resource.md?pivots=azportal#clean-up-resources)
83-
- [Azure CLI](../multi-service-resource.md?pivots=azcli#clean-up-resources)
82+
- [Azure portal](../../multi-service-resource.md?pivots=azportal#clean-up-resources)
83+
- [Azure CLI](../../multi-service-resource.md?pivots=azcli#clean-up-resources)

zone-pivots/zone-pivot-groups.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ groups:
7979
title: Python
8080
- id: programming-language-rest
8181
title: REST
82-
- id: programming-languages-content-safety-rest-portal
82+
- id: programming-languages-content-safety-foundry-rest
8383
# Owner: pafarley
8484
title: Programming languages
8585
prompt: Choose a platform

0 commit comments

Comments
 (0)