Skip to Content

Interface ShareFeedbackOptions

What MemoryOperations.shareFeedback records a batch of ratings from.

Ratings belong to the search that produced the results, so there is no domain to name and ShareFeedbackOptions.sessionId is required. One call rates one search, while its session id is still to hand.

At least one rating is required, and each must name the idx it is about — an empty batch is refused before anything is sent. A batch larger than the service accepts is refused too, rather than trimmed: every rating is a judgement about a specific result, so dropping the tail would silently record a verdict other than the one that was passed.

interface ShareFeedbackOptions {
    timeout?: number;
    sessionId: string;
    feedback: Iterable<FeedbackRating>;
}

Hierarchy (View Summary)

Index
timeout?: number

Seconds to wait for this call. Defaults to the client's own timeout.

sessionId: string

The session whose results are being rated.

feedback: Iterable<FeedbackRating>

The ratings. At least one.