Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
This service enables you to send updates to AI generated data back to Microsoft. The updates are used to improve the accuracy of the AI.
Provide feedback
PUT /feedback/notifications?api-version=2&customerId={customerId}
Sends updates to AI-generated information back to Microsoft.
Parameters
| Type | Name | Required | Description | Schema |
|---|---|---|---|---|
| Query | api-version |
Yes | The supported API version. Must be set to 2. | Integer (int32) |
| Query | customerId |
Yes | The Microsoft-defined identifier of the customer for whom the request is being made. | String (uuid) |
HTTP headers
| Name | Value |
|---|---|
Content-Type |
application/json |
Authorization |
Bearer <access token issued by your identity solution> |
Accept |
application/json |
Request body
At least one of notificationId and correlationId must be provided.
| Name | Required | Description | Schema |
|---|---|---|---|
partnerId |
Yes | The Microsoft-defined identifier of the partner providing feedback. | String (uuid) |
customerId |
Yes | The Microsoft-defined identifier of the customer for whom the feedback applies. | String (uuid) |
notificationId |
No | (Optional) The identifier of the notification for whom feedback is provided. | String (uuid) |
correlationId |
No | (Optional) The partner-defined correlation identifier. Allowed characters: letters, numbers, underscore (_), hyphen (-) and pipe (|). The maximum allowed length is 128 characters. | String |
eventFamily |
No | (Optional) The Microsoft-defined product name of the feedback receiver. This is typically the source of the notification to which the feedback would be intended. For example, DAX, Nursing. | String |
productId |
No | (Optional) The Microsoft-defined identifier of the the feedback receiver's product. This typically identifies the source of the notification for which the feedback would be intended. See Product identifiers. | String (uuid) |
type |
No | (Optional) The feedback type that can be used to specify the intent that can be useful to differentiate multiple feedback requests for the same encounter session. For example, it could be used to differentiate between feedback for orders and notes. | String |
data |
Yes | The partner's feedback in Microsoft standard format. | Stringified JSON |
Sample request
PUT /feedback/notifications?api-version=2&customerId=00000000-1111-2222-3333-444444444444
{
"partnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customerId": "00000000-1111-2222-3333-444444444444",
"notificationId": "096e7fc4-12f0-4a61-8305-e22b6129444d",
"correlationId": "correlation_id_1",
"eventFamily": "dax",
"data": "{\"feedback\":\"data\"}"
}
Response codes
| Code | Description | Links |
|---|---|---|
| 200 | Success. The feedback is submitted. | No links |
| 400 | Bad request. Required validations aren't passed. | No links |
| 401 | Not authorized. The access token is missing or invalid. | No links |
| 403 | Forbidden. The caller isn't authorized to send feedback. | No links |
| 404 | Resource not found. The notification ID or correlation ID is not found. | No links |
| 500 | Internal server error. Any other exceptional scenario where the application isn't able to complete the request. | No links |
Response body
{
"message": "Feedback submitted successfully"
}
Response body properties
| Name | Description | Schema |
|---|---|---|
message |
Success message. | String |