You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-services/content-safety/quickstart-groundedness.md
+10-12Lines changed: 10 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ Follow this guide to use Azure AI Content Safety Groundedness detection to check
26
26
27
27
## Check groundedness without reasoning
28
28
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`.
30
30
31
31
#### [cURL](#tab/curl)
32
32
@@ -108,11 +108,11 @@ To test a summarization task instead of a question answering (QnA) task, use the
108
108
109
109
```json
110
110
{
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
116
116
}
117
117
```
118
118
@@ -155,10 +155,9 @@ The JSON objects in the output are defined here:
155
155
| Name | Description | Type |
156
156
| :------------------ | :----------- | ------- |
157
157
|**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 |
159
158
|**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 |
160
159
|**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 |
162
161
163
162
## Check groundedness with reasoning
164
163
@@ -189,7 +188,7 @@ In order to use your Azure OpenAI GPT4-Turbo resource to enable the reasoning fe
189
188
190
189
### Make the API request
191
190
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:
193
192
194
193
```json
195
194
{
@@ -333,10 +332,9 @@ The JSON objects in the output are defined here:
333
332
| Name | Description | Type |
334
333
| :------------------ | :----------- | ------- |
335
334
|**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 |
337
335
|**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 |
338
336
|**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 |
340
338
| -**`offset`**| An object describing the position of the ungrounded text in various encoding. | String |
341
339
| - `offset > utf8`| The offset position of the ungrounded text in UTF-8 encoding. | Integer |
342
340
| - `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:
345
343
| - `length > utf8`| The length of the ungrounded text in UTF-8 encoding. | Integer |
346
344
| - `length > utf16`| The length of the ungrounded text in UTF-16 encoding. | Integer |
347
345
| - `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 |
0 commit comments