@coveo/platform-client 37.8.0 → 37.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definitions/resources/Pipelines/ResultRankings/ResultRankings.d.ts +2 -1
- package/dist/definitions/resources/Pipelines/ResultRankings/ResultRankingsInterfaces.d.ts +22 -6
- package/dist/resources/Pipelines/ResultRankings/ResultRankings.js +4 -0
- package/dist/resources/Pipelines/ResultRankings/ResultRankings.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import Resource from '../../Resource';
|
|
2
|
-
import { CopyResultRankingRequest, CopyResultRankingResponse, ListResultRankingParams, ListResultRankingResponse, ResultRanking, ResultRankingProps } from './ResultRankingsInterfaces';
|
|
2
|
+
import { BulkGetResultRankingsParams, CopyResultRankingRequest, CopyResultRankingResponse, ListResultRankingParams, ListResultRankingResponse, ResultRanking, ResultRankingProps } from './ResultRankingsInterfaces';
|
|
3
3
|
export default class ResultRankings extends Resource {
|
|
4
4
|
static getBaseUrl: (pipelineId: string) => string;
|
|
5
5
|
static getResultRankingsUrl: (pipelineId: string, resultRankingsId: string) => string;
|
|
@@ -12,4 +12,5 @@ export default class ResultRankings extends Resource {
|
|
|
12
12
|
createJSON(pipelineId: string, resultRanking: string): Promise<ResultRanking>;
|
|
13
13
|
duplicate(pipelineId: string, resultRankingsId: string): Promise<ResultRanking>;
|
|
14
14
|
copyTo(pipelineId: string, copyResultRankingRequest: CopyResultRankingRequest): Promise<CopyResultRankingResponse>;
|
|
15
|
+
bulkGet(pipelineId: string, { ids, ...allQueryStringOptions }: BulkGetResultRankingsParams): Promise<ListResultRankingResponse>;
|
|
15
16
|
}
|
|
@@ -194,7 +194,7 @@ export interface ListResultRankingResponse {
|
|
|
194
194
|
totalCount: number;
|
|
195
195
|
totalPages: number;
|
|
196
196
|
}
|
|
197
|
-
|
|
197
|
+
interface CoreGetResultRankingParams extends Paginated {
|
|
198
198
|
/**
|
|
199
199
|
* Whether to sort the results in ascending order.
|
|
200
200
|
*/
|
|
@@ -205,7 +205,6 @@ export interface ListResultRankingParams extends Paginated {
|
|
|
205
205
|
* By default, results are not required to match a specific query filter.
|
|
206
206
|
*/
|
|
207
207
|
filter?: string;
|
|
208
|
-
sortBy?: ListStatementSortBy;
|
|
209
208
|
/**
|
|
210
209
|
* The 0-based number of the page of results to get.
|
|
211
210
|
*/
|
|
@@ -218,15 +217,18 @@ export interface ListResultRankingParams extends Paginated {
|
|
|
218
217
|
* The unique identifier of the target Coveo Cloud organization.
|
|
219
218
|
*/
|
|
220
219
|
organizationId?: string;
|
|
221
|
-
/**
|
|
222
|
-
* The group names to allow in the results.
|
|
223
|
-
*/
|
|
224
|
-
associatedGroups?: Array<string | null>;
|
|
225
220
|
/**
|
|
226
221
|
* @deprecated `ruleTypes` should be preferred over _kind_.
|
|
227
222
|
* @see ruleTypes
|
|
228
223
|
*/
|
|
229
224
|
kind?: ResultRankingsKind;
|
|
225
|
+
}
|
|
226
|
+
export interface ListResultRankingParams extends CoreGetResultRankingParams {
|
|
227
|
+
sortBy?: ListStatementSortBy;
|
|
228
|
+
/**
|
|
229
|
+
* The group names to allow in the results.
|
|
230
|
+
*/
|
|
231
|
+
associatedGroups?: Array<string | null>;
|
|
230
232
|
/**
|
|
231
233
|
* Similar to `kind`, the _ruleTypes_ parameter allows to filter by result ranking rule type.
|
|
232
234
|
* This new parameter should be preferred over `kind` as it may eventually support other rule types.
|
|
@@ -264,3 +266,17 @@ export interface CopyResultRankingResponse {
|
|
|
264
266
|
resultRanking: ResultRankingProps;
|
|
265
267
|
}>;
|
|
266
268
|
}
|
|
269
|
+
export interface BulkGetResultRankingsParams extends CoreGetResultRankingParams {
|
|
270
|
+
ids: string[];
|
|
271
|
+
/**
|
|
272
|
+
* The enabled status of result ranking rules to allow in the returned list.
|
|
273
|
+
* Set to true to only allow rules whose enabled property is set to true, and vice versa.
|
|
274
|
+
* By default, both enabled and disabled rules are allowed.
|
|
275
|
+
*/
|
|
276
|
+
enabledStatus?: boolean;
|
|
277
|
+
/**
|
|
278
|
+
* The unique identifier of the statement group.
|
|
279
|
+
*/
|
|
280
|
+
statementGroupId?: string;
|
|
281
|
+
}
|
|
282
|
+
export {};
|
|
@@ -50,6 +50,10 @@ var ResultRankings = /** @class */ (function (_super) {
|
|
|
50
50
|
organizationId: this.api.organizationId,
|
|
51
51
|
}), copyResultRankingRequest);
|
|
52
52
|
};
|
|
53
|
+
ResultRankings.prototype.bulkGet = function (pipelineId, _a) {
|
|
54
|
+
var ids = _a.ids, allQueryStringOptions = tslib_1.__rest(_a, ["ids"]);
|
|
55
|
+
return this.api.post(this.buildPath("".concat(ResultRankings.getBaseUrl(pipelineId), "/bulkGet"), tslib_1.__assign({ organizationId: this.api.organizationId }, allQueryStringOptions)), { ids: ids });
|
|
56
|
+
};
|
|
53
57
|
ResultRankings.getBaseUrl = function (pipelineId) { return "/rest/search/v2/admin/pipelines/".concat(pipelineId, "/resultRankings"); };
|
|
54
58
|
ResultRankings.getResultRankingsUrl = function (pipelineId, resultRankingsId) {
|
|
55
59
|
return "".concat(ResultRankings.getBaseUrl(pipelineId), "/").concat(resultRankingsId);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ResultRankings.js","sourceRoot":"","sources":["../../../../src/resources/Pipelines/ResultRankings/ResultRankings.ts"],"names":[],"mappings":";;;AAAA,oEAAsC;
|
|
1
|
+
{"version":3,"file":"ResultRankings.js","sourceRoot":"","sources":["../../../../src/resources/Pipelines/ResultRankings/ResultRankings.ts"],"names":[],"mappings":";;;AAAA,oEAAsC;AAWtC;IAA4C,0CAAQ;IAApD;;IAiGA,CAAC;IA5FG,+BAAM,GAAN,UAAO,UAAkB,EAAE,gBAAwB;QAC/C,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAClB,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,oBAAoB,CAAC,UAAU,EAAE,gBAAgB,CAAC,EAAE;YAC9E,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,CACL,CAAC;IACN,CAAC;IAED,4BAAG,GAAH,UAAI,UAAkB,EAAE,gBAAwB;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,oBAAoB,CAAC,UAAU,EAAE,gBAAgB,CAAC,EAAE;YAC9E,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,CACL,CAAC;IACN,CAAC;IAED,+BAAM,GAAN,UAAO,UAAkB,EAAE,gBAAwB,EAAE,aAAiC;QAClF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,oBAAoB,CAAC,UAAU,EAAE,gBAAgB,CAAC,EAAE;YAC9E,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,EACF,aAAa,CAChB,CAAC;IACN,CAAC;IAED,mCAAU,GAAV,UAAW,UAAkB,EAAE,gBAAwB,EAAE,aAAqB;QAC1E,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,oBAAoB,CAAC,UAAU,EAAE,gBAAgB,CAAC,EAAE;YAC9E,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,EACF,aAAa,EACb,EAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC,EAAC,CACtF,CAAC;IACN,CAAC;IAED,6BAAI,GAAJ,UAAK,UAAkB,EAAE,MAAgC;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,sCAChD,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,IACpC,MAAM,KACT,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,CAAC,EAC1D,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,YAAY,CAAC,EAClD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,CAAC,IAC9C,CACL,CAAC;IACN,CAAC;IAED,+BAAM,GAAN,UAAO,UAAkB,EAAE,aAAiC;QACxD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAClD,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,EACF,aAAa,CAChB,CAAC;IACN,CAAC;IAED,mCAAU,GAAV,UAAW,UAAkB,EAAE,aAAqB;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAClD,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,EACF,aAAa,EACb,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC,EAAC,CACvF,CAAC;IACN,CAAC;IAED,kCAAS,GAAT,UAAU,UAAkB,EAAE,gBAAwB;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,UAAG,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,wBAAc,gBAAgB,CAAE,EAAE;YACrF,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,CACL,CAAC;IACN,CAAC;IAED,+BAAM,GAAN,UAAO,UAAkB,EAAE,wBAAkD;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,UAAG,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,UAAO,EAAE;YAC5D,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,EACF,wBAAwB,CAC3B,CAAC;IACN,CAAC;IAED,gCAAO,GAAP,UAAQ,UAAkB,EAAE,EAA4D;QAA3D,IAAA,GAAG,SAAA,EAAK,qBAAqB,sBAA9B,OAA+B,CAAD;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,UAAG,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,aAAU,qBAC7D,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,IACpC,qBAAqB,EAC1B,EACF,EAAC,GAAG,KAAA,EAAC,CACR,CAAC;IACN,CAAC;IA/FM,yBAAU,GAAG,UAAC,UAAkB,IAAK,OAAA,0CAAmC,UAAU,oBAAiB,EAA9D,CAA8D,CAAC;IACpG,mCAAoB,GAAG,UAAC,UAAkB,EAAE,gBAAwB;QACvE,OAAA,UAAG,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,cAAI,gBAAgB,CAAE;IAA9D,CAA8D,CAAC;IA8FvE,qBAAC;CAAA,AAjGD,CAA4C,kBAAQ,GAiGnD;kBAjGoB,cAAc"}
|