Skip to main content

Feedback API

The Feedback API allows submitting user feedback for the search/recommendation and research results. This feedback can be used to improve the quality of the results.

Endpoints

EndpointDescriptionRequest200 Response
POST /v1/articles/recommend/feedbackSubmits feedback for the found/recommended related articles.RecommendFeedbackRequestMessageResponse
POST /v1/articles/research/feedbackSubmits feedback for the research agent response.ResearchFeedbackRequestMessageResponse

POST /v1/articles/recommend/feedback

Submits feedback for the found/recommended related articles.

Examples

Example

Request:

{
"referenceKey": "3a0316b7-3632-40ab-98c2-a5fb3cb79eed",
"articleFeedback": [
{
"articleId": "https://www.snexplores.org/article/oldest-most-distant-galaxy-found",
"feedbackStatus": "accepted"
},
{
"articleId": "https://www.snexplores.org/article/scientist-say-light-year",
"feedbackStatus": "rejected"
}
]
}

Response:

{
"message": "Feedback submitted."
}

POST /v1/articles/research/feedback

Submits feedback for the research agent response.

Examples

Example

Request:

{
"interactionId": "3a0316b7-3632-40ab-98c2-a5fb3cb79eed",
"query": "How old is the universe?",
"answerFeedback": [
{
"text": "The most recent and accurate measurements indicated that the universe was approximately 13.81 billion years old.",
"feedbackStatus": "accepted"
},
{
"text": "Other methods, such as studying the oldest white dwarf stars and the rate of cosmic expansion, also yielded similar age estimates, generally between 13 and 14 billion years.",
"feedbackStatus": "rejected"
}
]
}

Response:

{
"message": "Feedback submitted."
}