URI: /api/conversation/v1/generative-ratings
CreateGenerativeExchangeRating
The Generative Feedback API provides, and manages, user feedback for a given generative exchange and response answer, allowing user input to access the accuracy of the question/answer pair.
Input model
| Field Name | Type | Description | Example Value |
| rating_id | string | UUID that uniquely identifies a particular exchange rating. Automatically generated on create. | 8ab21f90-78fc-4582-b1e0-fce39195a3a3 |
|
generative_exchange_id required |
string | This is an GenerativeExchangeResponseData generative_exchange_id from the Exchange Events API response. Specify type and populate this field. ExchangeRatings can only be created for exchanges matching active domains. | 5572cd8-65e9-46y7-9733-d2d7d123zz5z |
|
exchange_id optional |
string | Represents an extractive exchange_id associated with this response object from sources. | abe96862-7700-4547-978d-213085d1e1cc |
|
exchange_output_ids optional |
array of strings | A list of output_ids from extractive output that this generated answer is for. Relevant to n-best extractive exchange responses. Defaults to best_1. | best_1 |
|
creator_id |
string | Output field only, automatically populated. User ID (e.g. email address) that provided this feedback. | email@pryoninc.com |
|
question |
string | Output field only, automatically populated. The question that was recorded for the exchange that is being rated. | What is ML? |
|
rank required |
int32 | The feedback value given by the user. Values are 1 or 5 with 1 being negative (thumbs down) and 5 being positive (thumbs up). | 5 |
|
message optional |
string | User comment. Provides additional context on the rating. | The answer was on topic and helpful. |
|
freeform_text optional |
string | Freeform text for feedback provider. | I found the information very helpful. |
Request sample
Show code
{
"data": {
"rating_id": "string",
"generative_exchange_id": "string",
"exchange_id": "string",
"exchange_output_ids": [
"string"
],
"creator_id": "string",
"question": "string",
"rank": 0,
"message": "string",
"freeform_text": "string"
}
}
Response sample
Show code
{
"metadata": {
"uuid": "string",
"create_time": "2019-08-24T14:15:22Z",
"update_time": "2019-08-24T14:15:22Z",
"response_time_millis": 0
},
"data": {
"rating_id": "string",
"generative_exchange_id": "string",
"exchange_id": "string",
"exchange_output_ids": [
"string"
],
"creator_id": "string",
"question": "string",
"rank": 0,
"message": "string",
"freeform_text": "string"
}
}