@coveo/platform-client 37.4.0 → 37.5.0-alpha.0

package/dist/definitions/resources/MachineLearning/ModelInformation/ModelInformationInterfaces.d.ts

@@ -1,252 +1,252 @@
-export interface MLModelInfo<T extends MLModelTypeInfo = never> {
-    id: string;
-    info?: T;
-}
-export declare type MLModelTypeInfo = ModelInformationART | ModelInformationCC | ModelInformationDNE | ModelInformationER | ModelInformationPR | ModelInformationQS | ModelInformationSS;
-export interface MetaInfo {
-    modelName: string;
-    version: string;
-    environment: string;
-    org: string;
-    modelVersion: string;
-    createdDate: string;
-}
-export interface ModelInformationART {
-    metaInfo: MetaInfo;
-    modelBuildingStats: {
-        searchEventCount: number;
-        clickEventCount: number;
-        customEventCount: number;
-        segmentedVisitsCount: number;
-    };
-    totalQueries: number;
-    wordSelectionModels: Record<string, Record<string, number>>;
-    candidateExamples: Record<string, string[]>;
-    languages: {
-        [languageKey: string]: {
-            contextKeysToDocuments: any;
-            queries: number;
-            documents: number;
-            filters: any;
-            words: number;
-            stopwords: number;
-            docPerFilters: Record<string, number>;
-            [otherKeys: string]: any;
-        };
-    };
-    contentIDKeys: string[];
-    params: {
-        version: string;
-        maxBins: number;
-        topClicksTakeBins: number[];
-        topClicksMultBins: number[];
-        intersectMultBins: number[];
-        originalMultBins: number[];
-        stemmedMultBins: number[];
-        userContextMultBins: number[];
-        subqueryMultBins: number[];
-        subqueryLenThr: number;
-        clicksDecayParams: Record<string, number>;
-    };
-    featureSelectLog: FeatureSelectLog;
-    [key: string]: any;
-}
-export interface FeatureSelectLog {
-    [contextKey: string]: {
-        eventType: {
-            name: string;
-        };
-        statusMessage: string;
-    };
-}
-export interface ModelInformationDNE {
-    modelBuildingStats: {
-        visitsCount: number;
-        totalQueries: number;
-        searchEventCount: number;
-        clickEventCount: number;
-        facetSelectEventCount: number;
-    };
-    params: {
-        version: string;
-    };
-    totalQueries: number;
-    contentIDKeys?: string[];
-    languages: {
-        [languageKey: string]: {
-            topFacets: string[];
-            docPerFilters: Record<string, number>;
-            queries: number;
-        };
-    };
-    metaInfo: MetaInfo;
-}
-export interface ModelInformationER {
-    indicatorsModifier: Record<string, number>;
-    deprecatedUrlToFieldValueSize: number;
-    /**
-     * The sample of the top queries for which the model could recommend items for each listed context key.
-     *
-     * Consider using `contextCandidateExamples` which provides the same data but not prefixed with
-     * `c_context` and no `visit` suffix
-     */
-    candidateExamples: Record<string, string[]>;
-    /**
-     * The sample of the top queries for which the model could recommend items for each listed context key.
-     */
-    contextCandidateExamples: Record<string, string[]>;
-    primaryIdToValue: number;
-    eventGroups: string[];
-    primaryEventType: string;
-    params: {
-        languages: string[];
-        eventConfigs: any;
-        eventsToCombineMapping: any;
-        normalizeUrl: any;
-        querySplit: {
-            maxNgram: number;
-            keepOrigQuery: boolean;
-            keepStemQuery: boolean;
-            keepOrigNGramQuery: boolean;
-            keepStemNGramQuery: boolean;
-        };
-    };
-    contentIDKeys: string[];
-    primaryEventGroupName: string;
-    eventGroupValuesExamplesInHistory: any;
-    indicatorsMap: any;
-    metaInfo: MetaInfo;
-    modelBuildingStats: {
-        viewCount: number;
-        PageViewCount: number;
-        Query_stem1Count: number;
-        searchCount: number;
-        Query_stemCount: number;
-        clickCount: number;
-        [key: string]: number;
-    };
-    'Possible recommendations: ': number;
-    eventGroupsFields: Record<string, string[]>;
-    primaryEventName: string;
-    'Recommendations per language: ': Record<string, number>;
-    featureSelectLog: FeatureSelectLog;
-    [key: string]: any;
-}
-export interface ModelInformationPR {
-    metaInfo: MetaInfo;
-    itemBasedNamesAndNumOfRecordedItems: any;
-    itemBasedNamesWithCandidateItems: any;
-    numOfEventsPerEventType: any;
-    userBasedCandidates: any;
-    userBasedNumOfItems: any;
-    userBasedNumOfUsers: any;
-    contentIDKeys: string[];
-    parentIDKeys: [];
-    modelBuildingStats?: any;
-    languages?: any;
-}
-export interface ModelInformationQS {
-    numContextValues: number;
-    lastQueriesPerUser: number;
-    userContextPrefix: string;
-    knownPartialsWithSuggestions: number;
-    candidateExamples: Record<string, string[]>;
-    languages: string[];
-    minClickCountByLang: Record<string, number>;
-    userClusterMap: number;
-    candidatesPerLanguages: Record<string, number>;
-    filterFields: string[];
-    params: {
-        version: string;
-        contextBoost: number;
-        cooccurrenceBoost: number;
-        userClusterBoost: number;
-        partialQueryBoost: number;
-    };
-    candidates: number;
-    numUserClusters: number;
-    metaInfo: MetaInfo;
-    modelBuildingStats: {
-        searchEventCount: number;
-        clickEventCount: number;
-        filteredSearches: number;
-        customEventCount: number;
-    };
-    minCandWithContextBoost: number;
-    topCooccurrences: number;
-    ratioCandWithContextBoost: number;
-    userContextFields: string[];
-    maxQueryLength: number;
-    candidatesPerFilters: Record<string, number>;
-    topCooccurrencesExamples: Record<string, string[]>;
-    stopwords: Record<string, number>;
-    featureSelectLog: FeatureSelectLog;
-    [key: string]: any;
-}
-export interface MetaInfoSS extends MetaInfo {
-    modelId: string;
-    engineName: string;
-    modelSize: string;
-}
-export interface BuildingStatsSS {
-    documentCount: number;
-    snippetCount: number;
-    headerCount: number;
-    meanSnippetLength: number;
-}
-export interface ModelInformationSS {
-    metaInfo: MetaInfoSS;
-    modelBuildingStats: BuildingStatsSS;
-}
-export interface DatasetFieldDetails {
-    numSamples: number;
-    labelsDistribution: Record<string, number>;
-}
-export interface DatasetDetails {
-    numRows: number;
-    dataDetails: Record<string, DatasetFieldDetails>;
-}
-export interface FacetPerformanceDetails {
-    hit1: number;
-    hit3: number;
-}
-export interface HyperParameterDetails {
-    learningRate: number;
-    warmUp: number;
-}
-export interface FacetDetails {
-    facetLabels: Record<string, string[]>;
-    defaultFacets: Partial<Record<string, string>>;
-    facetDisregardedLabels: Record<string, string[]>;
-}
-export interface PreparationConfigCC {
-    documentGroupId: number;
-    caseIdColumn: string;
-    facetFields: string[];
-    contextFields: string[];
-    minLen: number;
-    maxLen: number;
-    maxPortionDisregarded: number;
-    condensationMapPath?: string;
-    testPortion: number;
-}
-export interface MetaInfoCC extends MetaInfo {
-    modelId: string;
-    engineName: string;
-    modelSize: string;
-}
-export interface PreparationDetailsCC {
-    preparationConfig: PreparationConfigCC;
-    facetsDetails: FacetDetails;
-    trainDatasetsDetails: DatasetDetails;
-    testDatasetsDetails: DatasetDetails;
-}
-export interface TrainingDetailsCC {
-    performanceDetails: Record<string, FacetPerformanceDetails>;
-    hyperParameterDetails: HyperParameterDetails;
-}
-export interface ModelInformationCC {
-    metaInfo: MetaInfoCC;
-    preparationDetails: PreparationDetailsCC;
-    trainingDetails: TrainingDetailsCC;
-}
+export interface MLModelInfo<T extends MLModelTypeInfo = never> {
+    id: string;
+    info?: T;
+}
+export declare type MLModelTypeInfo = ModelInformationART | ModelInformationCC | ModelInformationDNE | ModelInformationER | ModelInformationPR | ModelInformationQS | ModelInformationSS;
+export interface MetaInfo {
+    modelName: string;
+    version: string;
+    environment: string;
+    org: string;
+    modelVersion: string;
+    createdDate: string;
+}
+export interface ModelInformationART {
+    metaInfo: MetaInfo;
+    modelBuildingStats: {
+        searchEventCount: number;
+        clickEventCount: number;
+        customEventCount: number;
+        segmentedVisitsCount: number;
+    };
+    totalQueries: number;
+    wordSelectionModels: Record<string, Record<string, number>>;
+    candidateExamples: Record<string, string[]>;
+    languages: {
+        [languageKey: string]: {
+            contextKeysToDocuments: any;
+            queries: number;
+            documents: number;
+            filters: any;
+            words: number;
+            stopwords: number;
+            docPerFilters: Record<string, number>;
+            [otherKeys: string]: any;
+        };
+    };
+    contentIDKeys: string[];
+    params: {
+        version: string;
+        maxBins: number;
+        topClicksTakeBins: number[];
+        topClicksMultBins: number[];
+        intersectMultBins: number[];
+        originalMultBins: number[];
+        stemmedMultBins: number[];
+        userContextMultBins: number[];
+        subqueryMultBins: number[];
+        subqueryLenThr: number;
+        clicksDecayParams: Record<string, number>;
+    };
+    featureSelectLog: FeatureSelectLog;
+    [key: string]: any;
+}
+export interface FeatureSelectLog {
+    [contextKey: string]: {
+        eventType: {
+            name: string;
+        };
+        statusMessage: string;
+    };
+}
+export interface ModelInformationDNE {
+    modelBuildingStats: {
+        visitsCount: number;
+        totalQueries: number;
+        searchEventCount: number;
+        clickEventCount: number;
+        facetSelectEventCount: number;
+    };
+    params: {
+        version: string;
+    };
+    totalQueries: number;
+    contentIDKeys?: string[];
+    languages: {
+        [languageKey: string]: {
+            topFacets: string[];
+            docPerFilters: Record<string, number>;
+            queries: number;
+        };
+    };
+    metaInfo: MetaInfo;
+}
+export interface ModelInformationER {
+    indicatorsModifier: Record<string, number>;
+    deprecatedUrlToFieldValueSize: number;
+    /**
+     * The sample of the top queries for which the model could recommend items for each listed context key.
+     *
+     * Consider using `contextCandidateExamples` which provides the same data but not prefixed with
+     * `c_context` and no `visit` suffix
+     */
+    candidateExamples: Record<string, string[]>;
+    /**
+     * The sample of the top queries for which the model could recommend items for each listed context key.
+     */
+    contextCandidateExamples: Record<string, string[]>;
+    primaryIdToValue: number;
+    eventGroups: string[];
+    primaryEventType: string;
+    params: {
+        languages: string[];
+        eventConfigs: any;
+        eventsToCombineMapping: any;
+        normalizeUrl: any;
+        querySplit: {
+            maxNgram: number;
+            keepOrigQuery: boolean;
+            keepStemQuery: boolean;
+            keepOrigNGramQuery: boolean;
+            keepStemNGramQuery: boolean;
+        };
+    };
+    contentIDKeys: string[];
+    primaryEventGroupName: string;
+    eventGroupValuesExamplesInHistory: any;
+    indicatorsMap: any;
+    metaInfo: MetaInfo;
+    modelBuildingStats: {
+        viewCount: number;
+        PageViewCount: number;
+        Query_stem1Count: number;
+        searchCount: number;
+        Query_stemCount: number;
+        clickCount: number;
+        [key: string]: number;
+    };
+    'Possible recommendations: ': number;
+    eventGroupsFields: Record<string, string[]>;
+    primaryEventName: string;
+    'Recommendations per language: ': Record<string, number>;
+    featureSelectLog: FeatureSelectLog;
+    [key: string]: any;
+}
+export interface ModelInformationPR {
+    metaInfo: MetaInfo;
+    itemBasedNamesAndNumOfRecordedItems: any;
+    itemBasedNamesWithCandidateItems: any;
+    numOfEventsPerEventType: any;
+    userBasedCandidates: any;
+    userBasedNumOfItems: any;
+    userBasedNumOfUsers: any;
+    contentIDKeys: string[];
+    parentIDKeys: [];
+    modelBuildingStats?: any;
+    languages?: any;
+}
+export interface ModelInformationQS {
+    numContextValues: number;
+    lastQueriesPerUser: number;
+    userContextPrefix: string;
+    knownPartialsWithSuggestions: number;
+    candidateExamples: Record<string, string[]>;
+    languages: string[];
+    minClickCountByLang: Record<string, number>;
+    userClusterMap: number;
+    candidatesPerLanguages: Record<string, number>;
+    filterFields: string[];
+    params: {
+        version: string;
+        contextBoost: number;
+        cooccurrenceBoost: number;
+        userClusterBoost: number;
+        partialQueryBoost: number;
+    };
+    candidates: number;
+    numUserClusters: number;
+    metaInfo: MetaInfo;
+    modelBuildingStats: {
+        searchEventCount: number;
+        clickEventCount: number;
+        filteredSearches: number;
+        customEventCount: number;
+    };
+    minCandWithContextBoost: number;
+    topCooccurrences: number;
+    ratioCandWithContextBoost: number;
+    userContextFields: string[];
+    maxQueryLength: number;
+    candidatesPerFilters: Record<string, number>;
+    topCooccurrencesExamples: Record<string, string[]>;
+    stopwords: Record<string, number>;
+    featureSelectLog: FeatureSelectLog;
+    [key: string]: any;
+}
+export interface MetaInfoSS extends MetaInfo {
+    modelId: string;
+    engineName: string;
+    modelSize: string;
+}
+export interface BuildingStatsSS {
+    documentCount: number;
+    snippetCount: number;
+    headerCount: number;
+    meanSnippetLength: number;
+}
+export interface ModelInformationSS {
+    metaInfo: MetaInfoSS;
+    modelBuildingStats: BuildingStatsSS;
+}
+export interface DatasetFieldDetails {
+    numSamples: number;
+    labelsDistribution: Record<string, number>;
+}
+export interface DatasetDetails {
+    numRows: number;
+    dataDetails: Record<string, DatasetFieldDetails>;
+}
+export interface FacetPerformanceDetails {
+    hit1: number;
+    hit3: number;
+}
+export interface HyperParameterDetails {
+    learningRate: number;
+    warmUp: number;
+}
+export interface FacetDetails {
+    facetLabels: Record<string, string[]>;
+    defaultFacets: Partial<Record<string, string>>;
+    facetDisregardedLabels: Record<string, string[]>;
+}
+export interface PreparationConfigCC {
+    documentGroupId: number;
+    caseIdColumn: string;
+    facetFields: string[];
+    contextFields: string[];
+    minLen: number;
+    maxLen: number;
+    maxPortionDisregarded: number;
+    condensationMapPath?: string;
+    testPortion: number;
+}
+export interface MetaInfoCC extends MetaInfo {
+    modelId: string;
+    engineName: string;
+    modelSize: string;
+}
+export interface PreparationDetailsCC {
+    preparationConfig: PreparationConfigCC;
+    facetsDetails: FacetDetails;
+    trainDatasetsDetails: DatasetDetails;
+    testDatasetsDetails: DatasetDetails;
+}
+export interface TrainingDetailsCC {
+    performanceDetails: Record<string, FacetPerformanceDetails>;
+    hyperParameterDetails: HyperParameterDetails;
+}
+export interface ModelInformationCC {
+    metaInfo: MetaInfoCC;
+    preparationDetails: PreparationDetailsCC;
+    trainingDetails: TrainingDetailsCC;
+}

package/dist/definitions/resources/MachineLearning/ModelInformation/index.d.ts

@@ -1,2 +1,2 @@
-export * from './ModelInformation';
-export * from './ModelInformationInterfaces';
+export * from './ModelInformation';
+export * from './ModelInformationInterfaces';

package/dist/definitions/resources/MachineLearning/Models/Models.d.ts

@@ -1,13 +1,13 @@
-import Resource from '../../Resource';
-import { RegistrationModel } from '../MachineLearningInterfaces';
-import { MLModel } from './ModelsInterfaces';
-import { MLModelTypeInfo } from '../ModelInformation';
-export default class Models extends Resource {
-    static baseUrl: string;
-    list(engines?: string[]): Promise<MLModel<never>[]>;
-    listDetails(): Promise<MLModel<MLModelTypeInfo>[]>;
-    getDetails<T extends MLModelTypeInfo>(modelId: string): Promise<MLModel<T>>;
-    get(modelId: string): Promise<MLModel<never>>;
-    delete(modelId: string): Promise<Record<string, unknown>>;
-    update(modelId: string, update: RegistrationModel): Promise<MLModel<never>>;
-}
+import Resource from '../../Resource';
+import { RegistrationModel } from '../MachineLearningInterfaces';
+import { MLModel } from './ModelsInterfaces';
+import { MLModelTypeInfo } from '../ModelInformation';
+export default class Models extends Resource {
+    static baseUrl: string;
+    list(engines?: string[]): Promise<MLModel<never>[]>;
+    listDetails(): Promise<MLModel<MLModelTypeInfo>[]>;
+    getDetails<T extends MLModelTypeInfo>(modelId: string): Promise<MLModel<T>>;
+    get(modelId: string): Promise<MLModel<never>>;
+    delete(modelId: string): Promise<Record<string, unknown>>;
+    update(modelId: string, update: RegistrationModel): Promise<MLModel<never>>;
+}

package/dist/definitions/resources/MachineLearning/Models/ModelsInterfaces.d.ts

@@ -1,49 +1,49 @@
-import { GranularResource } from '../../BaseInterfaces';
-import { IntervalUnit, ModelActivenessState, ModelStatus } from '../../Enums';
-import { AssociatedPipelineModel } from '../../Pipelines';
-import { MLModelInfo, MLModelTypeInfo } from '../ModelInformation';
-export interface MLModel<T extends MLModelTypeInfo = never> extends MLModelInfo<T>, ModelAttributes, GranularResource {
-    orgId: string;
-    id: string;
-    engineId: string;
-    modelName: string;
-    modelDisplayName?: string;
-    modelCreationTime: number;
-    nextModelUpdateTime?: number;
-    modelVersion?: string;
-    engineVersion?: string;
-    platformVersion?: 1 | 2;
-    versionMatcher?: string;
-    modelErrorDescription?: ModelErrorDescription;
-    previousModelUpdateTime?: number;
-    intervalTime: number;
-    intervalUnit: IntervalUnit;
-    exportPeriod: string;
-    exportOffset?: string;
-    status: ModelStatus;
-    commandLineParameters?: string[];
-    extraConfig?: {
-        [key: string]: any;
-    };
-    commonFilter?: string;
-    customEventFilter?: string;
-    searchEventFilter?: string;
-    viewEventFilter?: string;
-    modelSizeStatistic?: number;
-    modelActivenessState?: ModelActivenessState;
-}
-export interface ModelErrorDescription {
-    customer_errors?: CustomerError[];
-}
-export interface CustomerError {
-    description?: string;
-    errorCode?: string;
-    errorType?: string;
-    precision?: string;
-    troubleshoot?: string;
-}
-export interface ModelAttributes {
-    associatedPipelines?: AssociatedPipelineModel[];
-    parsedExportOffset?: string;
-    parsedExportPeriod?: string;
-}
+import { GranularResource } from '../../BaseInterfaces';
+import { IntervalUnit, ModelActivenessState, ModelStatus } from '../../Enums';
+import { AssociatedPipelineModel } from '../../Pipelines';
+import { MLModelInfo, MLModelTypeInfo } from '../ModelInformation';
+export interface MLModel<T extends MLModelTypeInfo = never> extends MLModelInfo<T>, ModelAttributes, GranularResource {
+    orgId: string;
+    id: string;
+    engineId: string;
+    modelName: string;
+    modelDisplayName?: string;
+    modelCreationTime: number;
+    nextModelUpdateTime?: number;
+    modelVersion?: string;
+    engineVersion?: string;
+    platformVersion?: 1 | 2;
+    versionMatcher?: string;
+    modelErrorDescription?: ModelErrorDescription;
+    previousModelUpdateTime?: number;
+    intervalTime: number;
+    intervalUnit: IntervalUnit;
+    exportPeriod: string;
+    exportOffset?: string;
+    status: ModelStatus;
+    commandLineParameters?: string[];
+    extraConfig?: {
+        [key: string]: any;
+    };
+    commonFilter?: string;
+    customEventFilter?: string;
+    searchEventFilter?: string;
+    viewEventFilter?: string;
+    modelSizeStatistic?: number;
+    modelActivenessState?: ModelActivenessState;
+}
+export interface ModelErrorDescription {
+    customer_errors?: CustomerError[];
+}
+export interface CustomerError {
+    description?: string;
+    errorCode?: string;
+    errorType?: string;
+    precision?: string;
+    troubleshoot?: string;
+}
+export interface ModelAttributes {
+    associatedPipelines?: AssociatedPipelineModel[];
+    parsedExportOffset?: string;
+    parsedExportPeriod?: string;
+}

package/dist/definitions/resources/MachineLearning/Models/index.d.ts

@@ -1,2 +1,2 @@
-export * from './Models';
-export * from './ModelsInterfaces';
+export * from './Models';
+export * from './ModelsInterfaces';

package/dist/definitions/resources/MachineLearning/PQSConfiguration/PQSConfiguration.d.ts

@@ -1,6 +1,6 @@
-import Resource from '../../Resource';
-import { PQSConfigurationModel } from './PQSConfigurationInterfaces';
-export default class PQSConfiguration extends Resource {
-    static baseUrl: string;
-    createPQSModel(model: PQSConfigurationModel): Promise<PQSConfigurationModel>;
-}
+import Resource from '../../Resource';
+import { PQSConfigurationModel } from './PQSConfigurationInterfaces';
+export default class PQSConfiguration extends Resource {
+    static baseUrl: string;
+    createPQSModel(model: PQSConfigurationModel): Promise<PQSConfigurationModel>;
+}