@coveo/platform-client 35.0.0

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

@@ -0,0 +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;
+}

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

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

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

@@ -0,0 +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>>;
+}

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

@@ -0,0 +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;
+}

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

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

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

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

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

@@ -0,0 +1,40 @@
+import { IntervalUnit } from '../../Enums';
+export interface PQSConfigurationModel {
+    /**
+     * The unique identifier of the catalog to be used by the model to infer
+     * personalized suggestions based on product vectors.
+     */
+    catalogId: string;
+    /**
+     * The filter to apply to the 'Common' event dimensions (shared by all event types)
+     * of the UA data to learn from when rebuilding the model.
+     */
+    commonFilter?: string;
+    /**
+     * The period of UA data to learn from when rebuilding the model.
+     * The exportPeriod uses the moment when the model was last generated as a base.
+     * Must be in the ISO8601 period format (i.e., PyYmMwWdDThHmMsS).
+     */
+    exportPeriod?: string;
+    /**
+     * The number of intervalUnit to wait between each rebuild of the model.
+     * Must be greater than or equal to 1.
+     */
+    intervalTime?: number;
+    /**
+     * The duration unit to use when interpreting the rebuild intervalTime for the model.
+     */
+    intervalUnit?: IntervalUnit;
+    /**
+     * The model display name in the Coveo Administration console.
+     */
+    modelDisplayName: string;
+    /**
+     * The unique identifier of the target machine learning model.
+     */
+    modelId?: string;
+    /**
+     * The filter to apply to the 'Click' and 'Search' event dimensions of the UA data to learn from when rebuilding the model.
+     */
+    searchEventFilter?: string;
+}

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

@@ -0,0 +1,2 @@
+export * from './PQSConfiguration';
+export * from './PQSConfigurationInterfaces';

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

@@ -0,0 +1,17 @@
+import { New } from '../../BaseInterfaces';
+import Resource from '../../Resource';
+import { SmartSnippetsConfigurationModel, SmartSnippetsContentFields, SmartSnippetsContentFieldsParams, SmartSnippetsDocumentGroupPreview, SmartSnippetsDocumentGroupPreviewParams, SmartSnippetsDocumentTypes, SmartSnippetsDocumentTypesParams } from './SmartSnippetsConfigurationInterfaces';
+export default class SmartSnippetsConfiguration extends Resource {
+    static baseUrl: string;
+    static modelUrl: string;
+    static contentFieldsUrl: string;
+    static documentTypesUrl: string;
+    static previewUrl: string;
+    create(configModel: New<SmartSnippetsConfigurationModel, 'modelId'>): Promise<SmartSnippetsConfigurationModel>;
+    delete(modelId: string): Promise<Record<string, unknown>>;
+    get(modelId: string): Promise<SmartSnippetsConfigurationModel>;
+    update(configModel: SmartSnippetsConfigurationModel): Promise<SmartSnippetsConfigurationModel>;
+    contentFields(params: SmartSnippetsContentFieldsParams): Promise<SmartSnippetsContentFields>;
+    documentTypes(params: SmartSnippetsDocumentTypesParams): Promise<SmartSnippetsDocumentTypes>;
+    preview(params: SmartSnippetsDocumentGroupPreviewParams): Promise<SmartSnippetsDocumentGroupPreview>;
+}

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

@@ -0,0 +1,131 @@
+import { FilterConditions } from '../FilterConditions';
+export interface DocumentType {
+    /**
+     * The fields containing the content to use for smart snippets.
+     */
+    contentFields: string[];
+    /**
+     * The document type.
+     */
+    documentType: string;
+}
+export interface SmartSnippetsConfigurationModel {
+    /**
+     * The unique ID of the model.
+     */
+    modelId: string;
+    /**
+     * The model name to display.
+     * Example: My First Model
+     */
+    modelDisplayName: string;
+    /**
+     * The sources to consider.
+     */
+    sources: string[];
+    /**
+     * An array of filtering conditions.
+     */
+    filterConditions: FilterConditions[];
+    /**
+     * An array of css selectors to evaluate content to exclude.
+     */
+    cssSelectorsToExclude?: string[];
+    /**
+     * The document type for which content is in custom index fields.
+     */
+    documentTypes?: DocumentType[];
+}
+export declare type SmartSnippetsDocumentRequirementStatus = 'OK' | 'INSUFFICIENT_DOCUMENTS';
+export interface SmartSnippetsDocumentGroupPreviewParams {
+    /**
+     * The sources to consider.
+     */
+    sources: string[];
+    /**
+     * An array of filtering conditions.
+     */
+    filterConditions: FilterConditions[];
+}
+export interface SmartSnippetsDocumentGroupPreview {
+    /**
+     * The query that was used to fetch document information.
+     */
+    query: string;
+    /**
+     * Status indicating whether there are enough candidates for learning.
+     */
+    documentRequirementStatus: SmartSnippetsDocumentRequirementStatus;
+    /**
+     * The total number of documents in all sources.
+     */
+    numberOfDocuments: number;
+    /**
+     * The number of documents that match the conditions.
+     */
+    numberOfDocumentsMatchingConditions: number;
+    /**
+     * The number of documents that match the conditions and have a permanent id.
+     */
+    numberOfDocumentsWithPermanentId: number;
+    /**
+     * The number of documents that are candidates for learning.
+     */
+    numberOfValidDocuments: number;
+}
+export interface SmartSnippetsContentFieldsParams {
+    /**
+     * The type of documents to target.
+     */
+    documentType: string;
+    /**
+     * The sources to consider.
+     */
+    sources: string[];
+    /**
+     * An array of filtering conditions.
+     */
+    filterConditions: FilterConditions[];
+}
+export interface SmartSnippetsContentField {
+    /**
+     * The name of the field.
+     */
+    name: string;
+}
+export interface SmartSnippetsContentFields {
+    /**
+     * The query that was used to fetch document information.
+     */
+    query: string;
+    /**
+     * The list of fields that are non-empty for at least one document.
+     */
+    fields: SmartSnippetsContentField[];
+}
+export interface SmartSnippetsDocumentTypesParams {
+    /**
+     * The sources to consider.
+     */
+    sources: string[];
+    /**
+     * An array of filtering conditions.
+     */
+    filterConditions: FilterConditions[];
+}
+export interface SmartSnippetsDocumentType {
+    /**
+     * The document type.
+     */
+    documentType: string;
+}
+export interface SmartSnippetsDocumentTypes {
+    /**
+     * The query that was used to fetch document information.
+     */
+    query: string;
+    /**
+     * The document types in all sources.
+     */
+    documentTypes: SmartSnippetsDocumentType[];
+}

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

@@ -0,0 +1,2 @@
+export * from './SmartSnippetsConfiguration';
+export * from './SmartSnippetsConfigurationInterfaces';

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

@@ -0,0 +1,7 @@
+import Resource from '../../Resource';
+export default class UserActionHistoryConfiguration extends Resource {
+    static baseUrl: string;
+    create(): Promise<void>;
+    delete(): Promise<void>;
+    get(): Promise<boolean>;
+}

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

@@ -0,0 +1 @@
+export * from './UserActionHistoryConfiguration';

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

@@ -0,0 +1,11 @@
+export * from './MachineLearning';
+export * from './MachineLearningInterfaces';
+export * from './FilterConditions';
+export * from './Models/';
+export * from './ModelInformation/';
+export * from './ModelConfiguration/';
+export * from './DNEConfiguration';
+export * from './CaseClassificationConfiguration';
+export * from './SmartSnippetsConfiguration';
+export * from './PQSConfiguration';
+export * from './UserActionHistoryConfiguration';

package/dist/definitions/resources/ModifierTemplates/ModifierTemplateInterfaces.d.ts

@@ -0,0 +1,71 @@
+export interface ModifierModel {
+    /**
+     * Unique identifier
+     */
+    id: string;
+    /**
+     * English human friendly name
+     */
+    displayName: string;
+    /**
+     * Category the modifier belongs to.
+     * LICENSE and SYSTEM are more for internal use and might need to be filtered out from display
+     */
+    modifierType: ModifierType;
+    /**
+     * List of statements contained in the modifier
+     */
+    statements: ModifierStatementModel[];
+}
+export interface ModifierStatementModel {
+    /**
+     * The statement key to apply the value to
+     */
+    key: string;
+    /**
+     * The value to set on the key, always a string so "0" or "true" are correct
+     */
+    value: string;
+    /**
+     * How the value will be applied if there are other statements on the same key
+     */
+    operation: StatementOperation;
+}
+export interface ModifierStatementDetailModel {
+    /**
+     * The statement key to apply the value to
+     */
+    statementKey: string;
+    /**
+     * The license property the statement affects
+     */
+    mapping: string;
+    /**
+     * The type of value that should be used in the license when recomputing the properties
+     */
+    valueType: StatementOperation;
+    /**
+     * The strategy that will be used to resolve conflicts for statements on the same key
+     */
+    mergeStrategy: MergeStrategy;
+}
+export declare enum ModifierType {
+    system = "SYSTEM",
+    license = "LICENSE",
+    integration = "INTEGRATION",
+    extension = "EXTENSION",
+    feature = "FEATURE"
+}
+export declare enum StatementOperation {
+    set = "SET",
+    append = "APPEND",
+    remove = "REMOVE"
+}
+export declare enum MergeStrategy {
+    integerBiggerWins = "INTEGER_BIGGER_WINS",
+    integerLowerWins = "INTEGER_LOWER_WINS",
+    booleanFalseWins = "BOOLEAN_FALSE_WINS",
+    booleanTrueWins = "BOOLEAN_TRUE_WINS",
+    specificEnumValueWins = "SPECIFIC_ENUM_VALUE_WINS",
+    noMerge = "NO_MERGE"
+}

package/dist/definitions/resources/ModifierTemplates/ModifierTemplates.d.ts

@@ -0,0 +1,7 @@
+import Resource from '../Resource';
+import { ModifierModel, ModifierStatementDetailModel } from './ModifierTemplateInterfaces';
+export default class ModifierTemplates extends Resource {
+    static baseUrl: string;
+    list(): Promise<ModifierModel[]>;
+    listPossibleStatements(): Promise<ModifierStatementDetailModel[]>;
+}

package/dist/definitions/resources/ModifierTemplates/index.d.ts

@@ -0,0 +1,2 @@
+export * from './ModifierTemplates';
+export * from './ModifierTemplateInterfaces';

package/dist/definitions/resources/Notification/Subscription/Subscription.d.ts

@@ -0,0 +1,21 @@
+import Ressource from '../../Resource';
+import { EditSubscriptionModel, SubscriptionModel } from './SubscriptionInterfaces';
+export default class Subscription extends Ressource {
+    static getBaseUrl: (orgId: string) => string;
+    list(): Promise<SubscriptionModel[]>;
+    listCurrent(): Promise<SubscriptionModel[]>;
+    show(subscriptionId: string): Promise<SubscriptionModel>;
+    showCurrent(subscriptionId: string): Promise<SubscriptionModel>;
+    create(editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
+    createCurrent(editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
+    edit(subscriptionId: string, editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
+    editCurrent(subscriptionId: string, editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
+    delete(subscriptionId: string): Promise<Record<string, unknown>>;
+    deleteCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
+    enable(subscriptionId: string): Promise<Record<string, unknown>>;
+    enableCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
+    disable(subscriptionId: string): Promise<Record<string, unknown>>;
+    disableCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
+    test(subscriptionId: string): Promise<Record<string, unknown>>;
+    testCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
+}