@lableb/javascript-sdk
Version:
Lableb cloud search client for javascript
62 lines (50 loc) • 2.13 kB
text/typescript
import { BaseRequestParams, BuildRequestResult } from "../../types";
import { FeedbackDocument } from "../feedback/feedback.document.type";
export interface BatchAutocompleteFeedbackRequestParams extends
Omit<BaseRequestParams, "sessionId" | "userId" | "userIp" | "userCountry" | "sessionIdGenerator"> {
/**
* your autocomplete API Key copied from [Lableb Dashboard](https://dashboard.lableb.com)
*/
APIKey?: string,
/**
* the used autocomplete handler for the autocomplete function
*/
autocompleteHandler?: string,
/**
* feedback object
*
* ## Content of the feedback object: `documentFeedback`
*
* | field | type | description |
* | --------- | ------ | ----------- |
* | query* | string | query used in the autocomplete function |
* | itemId | string | document"s id clicked on or chosen by the user |
* | itemOrder | string | document"s order clicked on or chosen by the user |
* | url | string | document"s url clicked on or chosen by the user |
* | sessionId | string | uniques session id of the end user |
*/
documentsFeedbacks: FeedbackDocument[],
}
export interface SingleAutocompleteFeedbackRequestParams extends
Omit<BatchAutocompleteFeedbackRequestParams, "documentsFeedbacks"> {
/**
* feedback object
*
* ## Content of the feedback object: `documentFeedback`
*
* | field | type | description |
* | --------- | ------ | ----------- |
* | query* | string | query used in the autocomplete function |
* | itemId | string | document"s id clicked on or chosen by the user |
* | itemOrder | string | document"s order clicked on or chosen by the user |
* | url | string | document"s url clicked on or chosen by the user |
* | sessionId | string | uniques session id of the end user |
*/
documentFeedback: FeedbackDocument,
}
export interface BatchAutocompleteFeedbackRequestResult extends BuildRequestResult {
params: {
apikey?: string,
},
body: FeedbackDocument[],
}