Skip to content

Commit 8fe253f

Browse files
committed
copy PM changes
1 parent a18f5cc commit 8fe253f

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

articles/ai-services/content-safety/quickstart-groundedness.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Follow this guide to use Azure AI Content Safety Groundedness detection to check
2626

2727
## Check groundedness without reasoning
2828

29-
In the simple case without the _reasoning_ feature, the Groundedness detection API classifies the ungroundedness of the submitted content as `true` or `false` and provides a confidence score.
29+
In the simple case without the _reasoning_ feature, the Groundedness detection API classifies the ungroundedness of the submitted content as `true` or `false`.
3030

3131
#### [cURL](#tab/curl)
3232

@@ -108,11 +108,11 @@ To test a summarization task instead of a question answering (QnA) task, use the
108108
109109
```json
110110
{
111-
"Domain": "Medical",
112-
"Task": "Summarization",
113-
"Text": "Ms Johnson has been in the hospital after experiencing a stroke.",
114-
"GroundingSources": ["Our patient, Ms. Johnson, presented with persistent fatigue, unexplained weight loss, and frequent night sweats. After a series of tests, she was diagnosed with Hodgkin’s lymphoma, a type of cancer that affects the lymphatic system. The diagnosis was confirmed through a lymph node biopsy revealing the presence of Reed-Sternberg cells, a characteristic of this disease. She was further staged using PET-CT scans. Her treatment plan includes chemotherapy and possibly radiation therapy, depending on her response to treatment. The medical team remains optimistic about her prognosis given the high cure rate of Hodgkin’s lymphoma."],
115-
"Reasoning": false
111+
"domain": "Medical",
112+
"task": "Summarization",
113+
"text": "Ms Johnson has been in the hospital after experiencing a stroke.",
114+
"groundingSources": ["Our patient, Ms. Johnson, presented with persistent fatigue, unexplained weight loss, and frequent night sweats. After a series of tests, she was diagnosed with Hodgkin’s lymphoma, a type of cancer that affects the lymphatic system. The diagnosis was confirmed through a lymph node biopsy revealing the presence of Reed-Sternberg cells, a characteristic of this disease. She was further staged using PET-CT scans. Her treatment plan includes chemotherapy and possibly radiation therapy, depending on her response to treatment. The medical team remains optimistic about her prognosis given the high cure rate of Hodgkin’s lymphoma."],
115+
"reasoning": false
116116
}
117117
```
118118

@@ -155,10 +155,9 @@ The JSON objects in the output are defined here:
155155
| Name | Description | Type |
156156
| :------------------ | :----------- | ------- |
157157
| **ungroundedDetected** | Indicates whether the text exhibits ungroundedness. | Boolean |
158-
| **confidenceScore** | The confidence value of the _ungrounded_ designation. The score ranges from 0 to 1. | Float |
159158
| **ungroundedPercentage** | Specifies the proportion of the text identified as ungrounded, expressed as a number between 0 and 1, where 0 indicates no ungrounded content and 1 indicates entirely ungrounded content.| Float |
160159
| **ungroundedDetails** | Provides insights into ungrounded content with specific examples and percentages.| Array |
161-
| -**`Text`** | The specific text that is ungrounded. | String |
160+
| -**`text`** | The specific text that is ungrounded. | String |
162161

163162
## Check groundedness with reasoning
164163

@@ -189,7 +188,7 @@ In order to use your Azure OpenAI GPT4-Turbo resource to enable the reasoning fe
189188

190189
### Make the API request
191190

192-
In your request to the Groundedness detection API, set the `"Reasoning"` body parameter to `true`, and provide the other needed parameters:
191+
In your request to the Groundedness detection API, set the `"reasoning"` body parameter to `true`, and provide the other needed parameters:
193192

194193
```json
195194
{
@@ -333,10 +332,9 @@ The JSON objects in the output are defined here:
333332
| Name | Description | Type |
334333
| :------------------ | :----------- | ------- |
335334
| **ungroundedDetected** | Indicates whether the text exhibits ungroundedness. | Boolean |
336-
| **confidenceScore** | The confidence value of the _ungrounded_ designation. The score ranges from 0 to 1. | Float |
337335
| **ungroundedPercentage** | Specifies the proportion of the text identified as ungrounded, expressed as a number between 0 and 1, where 0 indicates no ungrounded content and 1 indicates entirely ungrounded content.| Float |
338336
| **ungroundedDetails** | Provides insights into ungrounded content with specific examples and percentages.| Array |
339-
| -**`Text`** | The specific text that is ungrounded. | String |
337+
| -**`text`** | The specific text that is ungrounded. | String |
340338
| -**`offset`** | An object describing the position of the ungrounded text in various encoding. | String |
341339
| - `offset > utf8` | The offset position of the ungrounded text in UTF-8 encoding. | Integer |
342340
| - `offset > utf16` | The offset position of the ungrounded text in UTF-16 encoding. | Integer |
@@ -345,7 +343,7 @@ The JSON objects in the output are defined here:
345343
| - `length > utf8` | The length of the ungrounded text in UTF-8 encoding. | Integer |
346344
| - `length > utf16` | The length of the ungrounded text in UTF-16 encoding. | Integer |
347345
| - `length > codePoint` | The length of the ungrounded text in terms of Unicode code points. |Integer |
348-
| -**`Reason`** | Offers explanations for detected ungroundedness. | String |
346+
| -**`reason`** | Offers explanations for detected ungroundedness. | String |
349347

350348
## Clean up resources
351349

0 commit comments

Comments
 (0)