@coveo/platform-client 55.13.2 → 56.1.0

package/dist/types/resources/MachineLearning/ModelDetailedInfo/ModelDetailedInfoInterfaces.d.ts

@@ -0,0 +1,95 @@
+import { MLModelStatus } from '../MachineLearningInterfaces.js';
+import { ModelDetails } from './details/ModelDetails.js';
+export interface ModelAssociation {
+    /**
+     * The unique identifier of the query pipeline to which the model is associated.
+     * @example 38b08160-d7d4-4626-8e03-53587c23415d
+     */
+    parentId: string;
+    /**
+     * The unique identifier of the model association.
+     * @example 917af358-13fd-4c8e-94af-7cf649bddc48
+     */
+    id: string;
+    /**
+     * The name of the query pipeline or case assist configuration the model is associated with.
+     * @example association name
+     */
+    name: string;
+    /**
+     * The type of the association.
+     * @example QUERY_PIPELINE
+     */
+    associationType: 'QUERY_PIPELINE' | 'CASE_ASSIST';
+}
+export interface ModelIssues {
+    /**
+     * A description of an error or limitation present in the model.
+     */
+    description: string;
+    /**
+     * The recommended action to perform to resolve the error or limitation.
+     */
+    troubleshoot: string;
+}
+export interface ModelStatusInfo {
+    /**
+     * The status of the model.
+     * @example ACTIVE
+     */
+    modelStatus: MLModelStatus;
+    /**
+     * The remaining days until the model is archived.
+     * @example 2
+     */
+    daysUntilArchival: number;
+}
+export interface ModelWithDetails {
+    /**
+     * The id of the engine.
+     * @Example topclicks
+     */
+    engineId: string;
+    /**
+     * The unique identifier of the target machine learning model.
+     * @example My_Model_ID
+     */
+    modelId: string;
+    /**
+     * The name of the model configuration.
+     * @example My model
+     */
+    modelDisplayName: string;
+    /**
+     * The associations related to this model.
+     * @example [{
+     *    "parentId": "38b08160-d7d4-4626-8e03-53587c23415d",
+     *    "id": "917af358-13fd-4c8e-94af-7cf649bddc48",
+     *    "name": "test pipeline",
+     *    "associationType": "QUERY_PIPELINE"
+     * }]
+     */
+    modelAssociations: ModelAssociation[];
+    /**
+     * The date and time the model was last updated.
+     * @example 1691762520000
+     */
+    estimatedPreviousModelUpdateTime: number;
+    /**
+     * The date and time the model is scheduled to start its next update.
+     * @example 1691762520000
+     */
+    nextModelUpdateTime: number;
+    /**
+     * The description and troubleshooting messages for a model error or limitation.
+     */
+    modelIssues: ModelIssues[];
+    /**
+     * The detailed information about the model.
+     */
+    modelDetails?: ModelDetails;
+    /**
+     * The current status of the model.
+     */
+    modelStatusInfo: ModelStatusInfo;
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetails.d.ts

@@ -0,0 +1,21 @@
+import { ModelDetailsBuildingStats } from './ModelDetailsBuildingStats.js';
+import { ModelDetailsLanguages } from './ModelDetailsLanguages.js';
+import { ModelDetailsSubModels } from './ModelDetailsSubModels.js';
+export interface ModelDetails {
+    possibleRecommendations?: number;
+    totalQueries?: number;
+    recommendationsPerLanguage?: Map<string, number>;
+    userContextFields?: string[];
+    contentIDKeys?: string[];
+    candidatesPerFilters?: Map<string, number>;
+    contextCandidateExamples?: Map<string, string[]>;
+    languages?: Map<string, ModelDetailsLanguages>;
+    candidateExamples?: Map<string, string[]>;
+    candidatesPerLanguages?: Map<string, number>;
+    minClickCountPerLang?: Map<string, number>;
+    subModels?: {
+        [key: string]: ModelDetailsSubModels;
+    };
+    candidates?: number;
+    modelDetailedBuildingStats?: ModelDetailsBuildingStats;
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsBuildingStats.d.ts

@@ -0,0 +1,30 @@
+import { ModelDetailsCommerceEvents } from './ModelDetailsCommerceEvents.js';
+import { ModelDetailsStatsPerSource } from './ModelDetailsStatsPerSource.js';
+export interface ModelDetailsBuildingStats {
+    documentWithSnippetRatio?: number;
+    headerCount?: number;
+    snippetCount?: number;
+    meanSnippetLength?: number;
+    documentCount?: number;
+    documentWithSnippetCount?: number;
+    searchEventCount?: number;
+    clickEventCount?: number;
+    viewEventCount?: number;
+    customEventCount?: number;
+    segmentedVisitsCount?: number;
+    searchCount?: number;
+    clickCount?: number;
+    viewCount?: number;
+    visitsCount?: number;
+    facetSelectEventCount?: number;
+    snippetsPerDocument?: {
+        min?: number;
+        max?: number;
+        mean?: number;
+    };
+    invalidHtmlDocumentCount?: number;
+    documentWithoutIdCount?: number;
+    documentWithDuplicatedIdCount?: number;
+    commerceEventCounts?: ModelDetailsCommerceEvents;
+    modelDetailedStatsPerSource?: ModelDetailsStatsPerSource[];
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsCommerceEvents.d.ts

@@ -0,0 +1,6 @@
+export interface ModelDetailsCommerceEvents {
+    removeFromCart?: number;
+    addToCart?: number;
+    addPurchase?: number;
+    detailView?: number;
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsLanguages.d.ts

@@ -0,0 +1,8 @@
+export interface ModelDetailsLanguages {
+    queries?: number;
+    words?: number;
+    stopwords?: number;
+    topfacets?: string[];
+    contextKeysToDocuments?: Map<string, number>;
+    docPerFilters?: Map<string, number>;
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsStatsPerSource.d.ts

@@ -0,0 +1,7 @@
+export interface ModelDetailsStatsPerSource {
+    sourceName: string;
+    documentCount: number;
+    invalidHtmlDocumentCount: number;
+    documentWithoutIdCount: number;
+    documentWithDuplicatedIdCount: number;
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsSubModels.d.ts

@@ -0,0 +1,5 @@
+export interface ModelDetailsSubModels {
+    numOfItems?: number;
+    candidates?: string[] | string[][];
+    numOfUsers?: number;
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/index.d.ts

@@ -0,0 +1,6 @@
+export * from './ModelDetails.js';
+export * from './ModelDetailsBuildingStats.js';
+export * from './ModelDetailsCommerceEvents.js';
+export * from './ModelDetailsLanguages.js';
+export * from './ModelDetailsStatsPerSource.js';
+export * from './ModelDetailsSubModels.js';

package/dist/types/resources/MachineLearning/ModelDetailedInfo/index.d.ts

@@ -0,0 +1,3 @@
+export * from './details/index.js';
+export * from './ModelDetailedInfo.js';
+export * from './ModelDetailedInfoInterfaces.js';

package/dist/types/resources/MachineLearning/ModelListing/ModelListingInterfaces.d.ts

@@ -1,43 +1,37 @@
+import { MLModelStatus } from '../MachineLearningInterfaces.js';
 export interface MLListingModel {
     /**
      * The model display name in the Coveo Administration console.
-     *
      * @Example `MyModelDisplayName`
      */
     modelDisplayName: string;
     /**
      * The unique identifier of the target machine learning model.
-     *
      * @Example `My_Model_ID`
      */
     modelId: string;
     /**
      * The id of the engine.
-     *
      * @Example `topclicks`
      */
     engineId: string;
     /**
      * The date and time the model was last updated.
-     *
      * @Example `1691762520000`
-     **/
+     */
     estimatedPreviousModelUpdateTime: number;
     /**
      * The date and time the model is scheduled to start its next update.
-     *
      * @Example `1691762520000`
      */
     nextModelUpdateTime: number;
     /**
      * Version of the platform.
-     *
      * @Example `2`
      */
     platformVersion: 1 | 2;
     /**
      * The model size statistic. Depending on the model type, this value represents the number of items or queries on which the model was built.
-     *
      * @Example `5`
      */
     modelSizeStatistic: number;
@@ -55,13 +49,11 @@ export interface MLListingModel {
 export interface MLModelStatusInfo {
     /**
      * The status of the model.
-     *
      * @Example `ACTIVE`
      */
-    modelStatus: 'ARCHIVED' | 'SOON_TO_BE_ARCHIVED' | 'BUILD_IN_PROGRESS' | 'ERROR' | 'ERROR_INTERNAL' | 'LIMITED' | 'NOT_ASSOCIATED' | 'ACTIVE' | 'INACTIVE';
+    modelStatus: MLModelStatus;
     /**
      * The remaining days until the model is archived.
-     *
      * @Example `4`
      */
     daysUntilArchival?: number;
@@ -69,25 +61,21 @@ export interface MLModelStatusInfo {
 export interface MLModelAssociation {
     /**
      * The unique identifier of the query pipeline to which the model is associated.
-     *
      * @Example `38b08160-d7d4-4626-8e03-53587c23415d`
      */
     parentId: string;
     /**
      * The unique identifier of the model association.
-     *
      * @Example `917af358-13fd-4c8e-94af-7cf649bddc48`
      */
     id: string;
     /**
      * The name of the query pipeline or case assist configuration the model is associated with.
-     *
      * @Example `association name`
      */
     name: string;
     /**
      * The type of the association.
-     *
      * @Example `QUERY_PIPELINE`
      */
     associationType: 'QUERY_PIPELINE' | 'CASE_ASSIST';

package/dist/types/resources/MachineLearning/PQSConfiguration/PQSConfigurationInterfaces.d.ts

@@ -39,7 +39,6 @@ export interface PQSConfigurationModel {
     searchEventFilter?: string;
     /**
      * The trackingIds that usage analytics events must contain for the model to use those events in its learning process. The model will use an event if it contains at least one of the specified IDs
-     *
      * @Example: [ "sport" ]
      */
     trackingIds: string[];

package/dist/types/resources/MachineLearning/RGAConfiguration/RelevanceGenerativeAnsweringConfigurationInterface.d.ts

@@ -2,7 +2,6 @@ import { DocumentRequirementStatus } from '../DocumentInterfaces.js';
 export interface RelevanceGenerativeAnsweringDocumentGroupPreview {
     /**
      * The query that was used to fetch document information.
-     *
      * @Example @source==("Salesforce Notifier")
      */
     query: string;
@@ -28,7 +27,6 @@ export interface RelevanceGenerativeAnsweringDocumentGroupPreview {
     documentLimit: number;
     /**
      * Status for the number of required documents to build the model.
-     *
      * @Example OK
      */
     documentRequirementStatus: DocumentRequirementStatus;

package/dist/types/resources/MachineLearning/SemanticEncoderConfiguration/SemanticEncoderConfigurationInterfaces.d.ts

@@ -2,7 +2,6 @@ import { DocumentRequirementStatus } from '../DocumentInterfaces.js';
 export interface SemanticEncoderDocumentGroupPreview {
     /**
      * The query that was used to fetch document information.
-     *
      * @Example @source==("Salesforce Notifier")
      */
     query: string;
@@ -28,7 +27,6 @@ export interface SemanticEncoderDocumentGroupPreview {
     documentLimit: number;
     /**
      * Status for the number of required documents to build the model.
-     *
      * @Example OK
      */
     documentRequirementStatus: DocumentRequirementStatus;

package/dist/types/resources/MachineLearning/SmartSnippetsConfiguration/SmartSnippetsConfigurationInterfaces.d.ts

@@ -13,7 +13,6 @@ export interface DocumentType {
 export interface SmartSnippetsDocumentGroupPreview {
     /**
      * The query that was used to fetch document information.
-     *
      * @Example @source==("Salesforce Notifier")
      */
     query: string;
@@ -47,7 +46,6 @@ export interface SmartSnippetsDocumentGroupPreview {
     numberOfDocumentsInSourcesMatchingFiltersWithPermanentId: number;
     /**
      * Status for the number of required documents to build the model.
-     *
      * @Example OK
      */
     documentRequirementStatus: DocumentRequirementStatus;

package/dist/types/resources/MachineLearning/index.d.ts

@@ -1,15 +1,16 @@
+export * from './CaseClassificationConfiguration/index.js';
+export * from './DNEConfiguration/index.js';
+export * from './DocumentInterfaces.js';
+export * from './FilterConditions.js';
+export * from './IAPRConfiguration/index.js';
 export * from './MachineLearning.js';
 export * from './MachineLearningInterfaces.js';
-export * from './FilterConditions.js';
-export * from './DocumentInterfaces.js';
-export * from './Models/index.js';
+export * from './ModelDetailedInfo/index.js';
 export * from './ModelInformation/index.js';
 export * from './ModelListing/index.js';
-export * from './DNEConfiguration/index.js';
-export * from './CaseClassificationConfiguration/index.js';
-export * from './SmartSnippetsConfiguration/index.js';
+export * from './Models/index.js';
 export * from './PQSConfiguration/index.js';
+export * from './RGAConfiguration/index.js';
 export * from './SemanticEncoderConfiguration/index.js';
-export * from './IAPRConfiguration/index.js';
+export * from './SmartSnippetsConfiguration/index.js';
 export * from './UserActionHistoryConfiguration/index.js';
-export * from './RGAConfiguration/index.js';

package/dist/types/resources/Organizations/Members/Members.d.ts

@@ -11,13 +11,11 @@ export default class Members extends Resource {
     /**
      * deletes the member from all groups of an organization.
      * Note: Deleted users can still be included by domain.
-     *
      * @param username The username of the member to delete.
      */
     delete(username: string): Promise<void>;
     /**
      * Shows a member of an organization.
-     *
      * @param username  The username of the member to show.
      */
     get(username: string): Promise<OrganizationMemberModel>;
@@ -27,19 +25,19 @@ export default class Members extends Resource {
     getPrivileges(): Promise<GlobalPrivilegeModel[]>;
     /**
      * Updates the members of an organization.
-     *
      * @param sendEmailToInvitedUsers Whether to send an invitation email alongside the invite(s). Default to true.
+     * @param model
+     * @param options
      */
     updateOrganizationMembers(model: OrganizationMemberModel[], options?: UpdateGroupOptions): Promise<OrganizationMemberModel[]>;
     /**
      * Updates a member of an organization.
-     *
      * @param username The username of the member to update.
+     * @param model
      */
     updateMember(username: string, model: OrganizationMemberModel): Promise<OrganizationMemberModel>;
     /**
      * Lists the groups to which an organization member belongs.
-     *
      * @param username The username of the user for which to list groups.
      */
     getGroups(username: string): Promise<GroupModel[]>;

package/dist/types/resources/Organizations/Organization.d.ts

@@ -22,15 +22,17 @@ export default class Organization extends Resource {
     /**
      * Pauses an [organization](https://docs.coveo.com/en/222/).
      * Required privilege: Organization - Edit
+     * @param organizationId
      */
     pause(organizationId?: string): Promise<Record<string, unknown>>;
     /**
      * Resumes a paused [organization](https://docs.coveo.com/en/222/).
      * Required privilege: Organization - Edit
+     * @param organizationId
      */
     resume(organizationId?: string): Promise<Record<string, unknown>>;
     updateAdditionalInformation(additionalInformationObj: Record<string, unknown>): Promise<Record<string, unknown>>;
-    getAdditionalInformation(organizationId?: string): Promise<any>;
+    getAdditionalInformation(organizationId?: string): Promise<Record<string, unknown>>;
     updateExperimentalStatus(allowed?: boolean): Promise<boolean>;
     listPrivileges(): Promise<PrivilegeModel[]>;
     listMyPrivileges(): Promise<PrivilegeModel[]>;

package/dist/types/resources/Organizations/OrganizationInterfaces.d.ts

@@ -21,7 +21,6 @@ export interface OrganizationsStatusModel {
      * - `ACTIVE`: The organization is healthy and fully functional.
      * - `PAUSED`: The organization is currently inactive.
      * - `DELETING`: The organization is currently in the process of being deleted.
-     *
      * @example `PAUSED`
      */
     lifeCycleState: string;
@@ -36,7 +35,6 @@ export interface OrganizationsStatusModel {
      * - `RESUMING`: The organization is transitioning to `ACTIVE`.
      * - `PAUSING_FAILED`: The organization threw an error while transitioning to `PAUSED`.
      * - `RESUMING_FAILED`: The organization threw an error while transitioning to `ACTIVE`.
-     *
      * @example `PAUSED`
      */
     pauseState: string;
@@ -50,7 +48,6 @@ export interface OrganizationsStatusModel {
     provisioningStatus: {
         /**
          * The progress, in percentage, of the ongoing provisioning.
-         *
          * @example `100`
          */
         currentProvisioningProgress: number;
@@ -60,7 +57,6 @@ export interface OrganizationsStatusModel {
         initialProvisioningDone: boolean;
         /**
          * The last time provisioning was successfully completed in number of milliseconds since UNIX epoch.
-         *
          * @example `1556722921779`
          */
         lastProvisioningCompletedDate: number;
@@ -81,7 +77,6 @@ export interface OrganizationsStatusModel {
      * Whether the organization enforces all of its resources (e.g., query pipelines, sources, etc.) to be read-only.
      *
      * **Note:** This parameter is typically only updated when an organization is inactive.
-     *
      * @default `false`
      */
     readOnly: boolean;
@@ -91,7 +86,6 @@ export interface OrganizationsStatusModel {
      * **Allowed values:**
      * - `HEALTHY`: The organization is healthy and fully functional.
      * - `ERROR`: The organization has thrown an error and is currently inactive.
-     *
      * @example `ERROR`
      */
     status: string;
@@ -117,7 +111,7 @@ export interface OrganizationModel {
         servingExperimentAllowed: boolean;
     };
 }
-export type AdditionalOrganizationField = 'status' | 'license' | string;
+export type AdditionalOrganizationField = 'status' | 'license' | (string & {});
 export interface GetOrganizationOptions {
     additionalFields?: AdditionalOrganizationField | AdditionalOrganizationField[];
 }

package/dist/types/resources/Pipelines/Conditions/Condition.d.ts

@@ -5,38 +5,32 @@ export default class Condition extends Resource {
     static baseUrl: string;
     /**
      * Returns a paginated list of condition models.
-     *
-     * @param {ListConditionsOptions} options
+     * @param options
      */
     list(options?: ListConditionsOptions): Promise<PageModel<ConditionModel, "statements">>;
     /**
      * Creates and returns a new condition model.
-     *
-     * @param {NewConditionModel} conditionModel
+     * @param conditionModel
      */
     create(conditionModel: NewConditionModel): Promise<ConditionModel>;
     /**
      * Delete a condition model.
-     *
-     * @param {string} conditionId The unique identifier of the condition to be deleted.
+     * @param conditionId The unique identifier of the condition to be deleted.
      */
     delete(conditionId: string): Promise<Record<string, unknown>>;
     /**
      * Returns a condition model.
-     *
-     * @param {string} conditionId The unique identifier of the condition to be fetched.
+     * @param conditionId The unique identifier of the condition to be fetched.
      */
     get(conditionId: string): Promise<ConditionModel>;
     /**
      * Update a condition model with the model sent and returns the updated condition model.
-     *
-     * @param {string} conditionId The unique identifier of the condition to be updated.
-     * @param {ConditionModel | NewConditionModel} conditionModel
+     * @param conditionId The unique identifier of the condition to be updated.
+     * @param conditionModel
      */
     update(conditionId: string, conditionModel: ConditionModel | NewConditionModel): Promise<ConditionModel>;
     /**
      * Bulk get a list of conditions corresponding of the ids sent.
-     *
      * @param {string[]} conditionIds The list of condition's ids to be fetched. Limit of 1000 incoming ids.
      * @param {ListConditionsOptions} params
      */

package/dist/types/resources/Pipelines/Conditions/ConditionInterfaces.d.ts

@@ -65,7 +65,6 @@ export interface NewConditionModel {
 export interface ListConditionsOptions extends Paginated {
     /**
      * Whether to sort the results in ascending order.
-     *
      * @default true
      */
     isOrderAscending?: boolean;
@@ -77,7 +76,6 @@ export interface ListConditionsOptions extends Paginated {
     filter?: string;
     /**
      * The sort criteria to apply on the results.
-     *
      * @default ListStatementSortBy.Position
      */
     sortBy?: ListStatementSortBy;

package/dist/types/resources/Pipelines/MLAssociations/MLAssociationsInterfaces.d.ts

@@ -28,8 +28,7 @@ export interface MLAssociationModel {
     rankingModifier?: number;
     useAdvancedConfiguration?: boolean;
 }
-export interface ListAssociationsParams extends Paginated {
-}
+export type ListAssociationsParams = Paginated;
 export interface BulkGetAssociationsParams extends Paginated {
     ids: string[];
 }

package/dist/types/resources/Pipelines/PipelinesInterfaces.d.ts

@@ -5,7 +5,6 @@ interface PipelineInterfaceUrl {
      * Url of the pages affected by this query pipeline.
      *
      * string
-     *
      * @example: 'www.acme.com'
      */
     url: string;
@@ -29,7 +28,6 @@ interface PipelineShared {
      * The name of this query pipeline.
      *
      * string
-     *
      * @example: 'Community'
      */
     name: string;
@@ -37,9 +35,7 @@ interface PipelineShared {
      * The intended purpose of this query pipeline.
      *
      * string
-     *
      * @example: 'Provide contextually relevant query recommendations/results to Community site users.'
-     
      */
     description?: string;
     /**
@@ -51,7 +47,6 @@ interface PipelineShared {
      * (assuming, of course, that this query pipeline is not the current default query pipeline).
      *
      * boolean
-     *
      * @example: false
      */
     isDefault?: boolean;
@@ -73,7 +68,6 @@ interface PipelineShared {
      * See also the `splitTestTarget`, `splitTestRatio`, and `splitTestEnabled` properties.
      *
      * string
-     *
      * @example: 'Community VS default'
      */
     splitTestName?: string;
@@ -86,7 +80,6 @@ interface PipelineShared {
      * double
      * maximum: 1
      * minimum: 0
-     *
      * @example: 0.5
      */
     splitTestRatio?: number;
@@ -96,7 +89,6 @@ interface PipelineShared {
      * See also the `splitTestName`, `splitTestRatio`, and `splitTestEnabled` properties.
      *
      * string
-     *
      * @example: '22a3860e-fa6f-4e64-a9f1-ef738af0786e'
      */
     splitTestTarget?: string;
@@ -110,7 +102,6 @@ interface PipelineShared {
      * otherwise you risk filling up the cache with useless data.
      *
      * string
-     *
      * @example: '@source==CommunityForum OR @source==CommunityDocumentation'
      */
     filter?: string;
@@ -120,7 +111,6 @@ interface PipelineShared {
      * to provide better support and improve the tools we provide.
      *
      * string
-     *
      * @example: 'Service & Support'
      */
     useCase?: string;
@@ -132,7 +122,6 @@ export interface PipelineModel extends PipelineShared {
      * The unique identifier of this query pipeline.
      *
      * string
-     *
      * @example: '120deecf-7822-4d7b-885f-53f184a3a76c'
      */
     id: string;
@@ -141,7 +130,6 @@ export interface PipelineModel extends PipelineShared {
      * in this Coveo Cloud organization.
      *
      * integer
-     *
      * @example: 3
      */
     position?: number;
@@ -149,7 +137,6 @@ export interface PipelineModel extends PipelineShared {
      * The identifier of the Coveo Cloud platform user who originally created this query pipeline.
      *
      * string
-     *
      * @example: 'asmith@coveo.com'
      */
     created_by?: string;
@@ -157,7 +144,6 @@ export interface PipelineModel extends PipelineShared {
      * The identifier of the Coveo Cloud platform user who last modified this query pipeline.
      *
      * string
-     *
      * @example: 'bjones@coveo.com'
      */
     last_modified_by?: string;
@@ -171,7 +157,6 @@ export interface PipelineDetailedModel extends PipelineModel {
      * The unique identifier of query pipeline A in the A/B test.
      *
      * See also the splitTestName, splitTestRatio, and splitTestEnabled properties
-     *
      * @example: '22a3860e-fa6f-4e64-a9f1-ef738af0786e'
      */
     splitTestOriginalPipeline?: string;

package/dist/types/resources/Pipelines/ResultRankings/ResultRankings.d.ts

@@ -15,7 +15,6 @@ export default class ResultRankings extends Resource {
     bulkGet(pipelineId: string, { ids, ...allQueryStringOptions }: BulkGetResultRankingsParams): Promise<ListResultRankingResponse>;
     /**
      * Delete multiple result rankings rules in batch for a specific pipeline.
-     *
      * @param pipelineId The unique identifier of the target query pipeline.
      * @param ids A list of result ranking rule identifiers to delete. A maximum of 100 can be sent.
      */