@cognigy/rest-api-client 0.9.1 → 0.12.0

package/build/shared/interfaces/messageAPI/ai.d.ts

@@ -1,566 +0,0 @@
-import { IntentScore } from "../resources/intents";
-import { IGoogleResponse, IMicrosoftTeamsData, IGoogleAccountLinkedUser, ISlackData, ITwilioAutopilotData, IMicrosoftBotFrameworkData, TRingCentralEngageData } from "../endpointInterface";
-import { IAlexaRequestBody } from "../alexa";
-import { ITwilioAutopilotRequestBody } from "../twilioInterface";
-import { IDialogflowRequest } from "../dialogflowInterface";
-import { IDialogflowEndpointSettings, TChannelType, ITwilioAutopilotEndpointSettings, TDashbotPlatform, TEndpointType } from "./endpoints";
-import { IPayloadBaseMetaData } from "../amqpInterface";
-import { ISystemSlots } from "../cognigySlots";
-import { IAnalyticsSourceData } from "../analytics";
-import { THandoverProvider } from "../handover";
-import { IProjectScope, IOrganisationScope } from "../security";
-import { TDebugEventType } from "../debugEvents/TDebugEventType";
-import { IFinalPingEventPayload } from "../debugEvents/IFinalPingEventPayload";
-import { ILoggerStack } from "../../errors";
-import { IJSONSchema } from "../../json-schema";
-export interface IUser {
-    userId: string;
-    sessionId: string;
-    channel: TChannelType;
-    endpointType: TEndpointType;
-    ip: string;
-    organisation: string;
-    type: "user" | "device";
-}
-export declare const userSchema: IJSONSchema<IUser>;
-/**
- * The payload to process a message
- * with a flow in AI.
- */
-export interface IProcessInputPayload {
-    type: "processInput";
-    data: IProcessInputData;
-}
-export interface IProcessInputData extends IPayloadBaseMetaData {
-    user: IUser;
-    message: {
-        text?: string;
-        data?: {
-            [key: string]: any;
-        };
-    };
-    config: IProcessInputDataConfig;
-    /**
-     * Settings that are endpoint specific.
-     */
-    endpointSettings?: IProcessInputEndpointSettings;
-}
-export interface IProcessInputDataConfig {
-    flowId: string;
-    entrypoint: string;
-    localeReferenceId: string;
-    reloadFlow: boolean;
-    resetFlow: boolean;
-    resetContext: boolean;
-    resetState: boolean;
-    /**
-     * The id of the NLUConnector to use.
-     */
-    nluConnectorId: string;
-    /**
-     * Whether we should log analytics for messages
-     * received from this endpoint
-     */
-    useAnalytics: boolean;
-    /**
-     * Whether we should create / update
-     * Contact Profiles for this message
-     */
-    useContactProfiles: boolean;
-    /**
-     * Whether to collect conversations history for this endpoint
-     */
-    useConversations: boolean;
-    /**
-     * Whether to mask sensitive data in analytics for this endpoint
-     */
-    maskAnalytics: boolean;
-    /**
-     * Whether to mask sensitive data in logs for this endpoint
-     */
-    maskLogging: boolean;
-    /**
-     * Whether to use Chatbase
-     * to collect analytics data
-     */
-    useChatbaseAnalytics: boolean;
-    /**
-     * The apikey of the Chatbase
-     * bot to collect analytics for.
-     * Only matters if the useChatbaseAnalytics
-     * is true.
-     */
-    chatbaseApikey: string;
-    /**
-     * Whether to use Dashbot
-     * to collect analytics data
-     */
-    useDashbotAnalytics: boolean;
-    /**
-     * The apikey of the Dashbot
-     * bot to collect analytics for.
-     * Only matters if the useDashbotAnalytics
-     * is true.
-     */
-    dashbotApikey: string;
-    /**
-     * The selected platform of the Dashbot
-     * bot to collect analytics for.
-     * Only matters if the useDashbotAnalytics
-     * is true.
-     */
-    dashbotPlatform: TDashbotPlatform;
-    /**
-     * The URLToken of the Endpoint
-     * that is sused.
-     */
-    URLToken: string;
-    handoverSettings: {
-        /**
-         * Whether to send all messages from the
-         * user to the configured handover tool,
-         * or whether to only send the conversations
-         * that are actually in a handover
-         */
-        forwardOnlyHandoverConversations: boolean;
-        provider: THandoverProvider;
-        /**
-         * Whether to inject the message
-         * into the Flow even if we are in a handover
-         */
-        injectMessageToFlow?: boolean;
-    };
-    sessionExpiration: number;
-}
-/**
- * Endpoint specific settings
- * that AI needs to know about.
- */
-export declare type IProcessInputEndpointSettings = IProcessInputAlexaSettings | IProcessInputDialogflowSettings | {};
-export interface IProcessInputAlexaSettings {
-    /**
-     * Whether to reparse slots
-     * found by Alexa with COGNIGY.AI NLU.
-     */
-    reparseAlexaSlots: boolean;
-}
-export interface IProcessInputDialogflowSettings extends IDialogflowEndpointSettings {
-}
-export interface IProcessInputTwilioAutopilotSettings extends ITwilioAutopilotEndpointSettings {
-}
-export interface IProcessInputHeaders {
-    /**
-     * This is a unique id that is used by the endpoint to find the endpointClient instance that processed the message from the user.
-     * The endpointClient instance knows the channel, the userId and most importantly the response object to use to respond to the user.
-     */
-    endpointClientInstanceId: string;
-    endpointId: string;
-}
-export interface IProcessOutputPayload {
-    type: TDebugEventType;
-    data: IProcessOutputData;
-}
-export interface IProcessOutputData extends ILoggerStack {
-    text?: string;
-    data?: AnyProcessOutputData;
-    type?: IFinalPingEventPayload["type"];
-    analyticsData?: IAnalyticsSourceData;
-    [key: string]: any;
-}
-export declare type TFinalPingType = "regular" | "cognigyStopFlow";
-export declare type AnyProcessOutputData = IProcessOutputAlexaData | IProcessOutputAudioCodesData | IProcessOutputFacebookData | IProcessOutputGoogleData | IProcessOutputLineData | IProcessOutputMicrosoftBotFrameworkData | IProcessOutputMicrosoftTeamsData | IProcessOutputRingCentralEngageData | IProcessOutputSlackData | IProcessOutputSmoochData | IProcessOutputTwilioData | IProcessOutputTwilioAutopilotData | IProcessOutputTwilioSmsData | IProcessOutputUserlikeData | ISwitchedFlowData | {
-    [key: string]: any;
-};
-export interface ICognigySayObject extends Partial<IProcessOutputAlexaDataObject>, Partial<IProcessOutputAudioCodesDataObject>, Partial<IProcessOutputFacebookDataObject>, Partial<IProcessOutputGoogleDataObject>, Partial<IProcessOutputLineDataObject>, Partial<IProcessOutputMicrosoftBotFrameworkDataObject>, Partial<IProcessOutputRingCentralEngageDataObject>, Partial<IProcessOutputSlackDataObject>, Partial<IProcessOutputDefaultDataObject>, Partial<IProcessOutputSmoochDataObject>, Partial<IProcessOutputTwilioDataObject>, Partial<IProcessOutputTwilioAutopilotDataObject>, Partial<IProcessOutputTwilioSmsDataObject>, Partial<IProcessOutputUserlikeDataObject>, Partial<IProcessOutputWebchatDataObject> {
-}
-/**
- * Alexa
- */
-export interface IProcessOutputAlexaData {
-    _cognigy: IProcessOutputAlexaDataObject;
-}
-export interface IProcessOutputAlexaDataObject {
-    _alexa: {
-        [key: string]: any;
-    };
-}
-/**
- * AudioCodes
- */
-export interface IProcessOutputAudioCodesData {
-    _cognigy: IProcessOutputAudioCodesDataObject;
-}
-export interface IProcessOutputAudioCodesDataObject {
-    _audioCodes: {
-        text?: string;
-        json?: {
-            activities: IAudioCodesActivity[];
-        };
-    };
-}
-export interface IAudioCodesActivity {
-    id: string;
-    timestamp: string;
-    type: "event" | "message";
-    text?: string;
-    speak?: string;
-    name?: "start" | "hangup" | "handover";
-    channelData?: {
-        callee: string;
-        caller: string;
-    };
-    parameters?: {
-        caller: string;
-    };
-}
-/**
- * Facebook
- */
-export interface IProcessOutputFacebookData {
-    _cognigy: IProcessOutputFacebookDataObject;
-}
-export interface IProcessOutputFacebookDataObject {
-    _facebook: {
-        [key: string]: any;
-    };
-}
-/**
- * Google / Google Actions
- */
-export interface IProcessOutputGoogleData {
-    _cognigy: IProcessOutputGoogleDataObject;
-}
-export interface IProcessOutputGoogleDataObject {
-    _google: IGoogleResponse;
-}
-/**
- * Line
- */
-export interface IProcessOutputLineData {
-    _cognigy: IProcessOutputLineDataObject;
-}
-export interface IProcessOutputLineDataObject {
-    _line: {
-        [key: string]: any;
-    };
-}
-/**
- * MicrosoftBotFramework
- */
-export interface IProcessOutputMicrosoftBotFrameworkData {
-    _cognigy: IProcessOutputMicrosoftBotFrameworkDataObject;
-}
-export interface IProcessOutputMicrosoftBotFrameworkDataObject {
-    _microsoftBotFramework: IMicrosoftBotFrameworkData;
-}
-/**
- * MicrosoftTeams
- */
-export interface IProcessOutputMicrosoftTeamsData {
-    _cognigy: IProcessOutputMicrosoftTeamsDataObject;
-}
-export interface IProcessOutputMicrosoftTeamsDataObject {
-    _microsoftTeams: IMicrosoftTeamsData;
-}
-/**
- * RingCentralEngage
- */
-export interface IProcessOutputRingCentralEngageData {
-    _cognigy: IProcessOutputRingCentralEngageDataObject;
-}
-export interface IProcessOutputRingCentralEngageDataObject {
-    _ringCentralEngage: TRingCentralEngageData;
-}
-/**
-* Slack
-*/
-export interface IProcessOutputSlackData {
-    _cognigy: IProcessOutputSlackDataObject;
-}
-export interface IProcessOutputSlackDataObject {
-    _slack: ISlackData;
-}
-/**
- * Default (our own structured messages format)
- */
-export interface IProcessOutputDefaultData {
-    _cognigy: IProcessOutputDefaultDataObject;
-}
-export interface IProcessOutputDefaultDataObject {
-    _default: any;
-}
-/**
-* Smooch (now sunshine conversations)
-*/
-export interface IProcessOutputSmoochData {
-    _cognigy: IProcessOutputSmoochDataObject;
-}
-export interface IProcessOutputSmoochDataObject {
-    _smooch: {
-        [key: string]: any;
-    };
-}
-/**
- * Twilio
- */
-export interface IProcessOutputTwilioData {
-    _cognigy: IProcessOutputTwilioDataObject;
-}
-export interface IProcessOutputTwilioDataObject {
-    _twilio: {
-        text?: string;
-        twiml?: string;
-    };
-}
-/**
- * TwilioAutopilot
- */
-export interface IProcessOutputTwilioAutopilotData {
-    _cognigy: IProcessOutputTwilioAutopilotDataObject;
-}
-export interface IProcessOutputTwilioAutopilotDataObject {
-    _twilioAutopilot: ITwilioAutopilotData;
-}
-/**
- * TwilioSms
- */
-export interface IProcessOutputTwilioSmsData {
-    _cognigy: IProcessOutputTwilioSmsDataObject;
-}
-export interface IProcessOutputTwilioSmsDataObject {
-    _twilioSms: {
-        text?: string;
-        twiml?: string;
-    };
-}
-/**
-* Userlike
-*/
-export interface IProcessOutputUserlikeData {
-    _cognigy: IProcessOutputUserlikeDataObject;
-}
-export interface IProcessOutputUserlikeDataObject {
-    _userlike: {
-        text?: string;
-        json?: {
-            answers: any[];
-            context: {
-                [key: string]: any;
-            };
-        };
-    };
-}
-/**
- * Webchat (this is actually webchat 2, both formats are similar)
- */
-export interface IProcessOutputWebchatData {
-    _cognigy: IProcessOutputWebchatDataObject;
-}
-export interface IProcessOutputWebchatDataObject {
-    _webchat: {
-        [key: string]: any;
-    };
-}
-export interface ISwitchedFlowData {
-    type: string;
-    fromFlowId: string;
-    toFlowId: string;
-}
-export interface IProcessOutputHeaders {
-    /**
-     * This is a unique id that is used by the endpoint to find the endpointClient instance that processed the message from the user.
-     * The endpointClient instance knows the channel, the userId and most importantly the response object to use to respond to the user.
-     */
-    endpointClientInstanceId: string;
-}
-export interface ILexiconChangedPayload {
-    type: "lexiconChanged";
-    data: ILexiconChangedData;
-}
-export interface ILexiconChangedData extends IPayloadBaseMetaData {
-    lexiconId: string;
-}
-export interface IProjectSettingsChangedPayload {
-    type: "projectSettingsChanged";
-    data: IProjectSettingsChangedData;
-}
-export interface IProjectSettingsChangedData extends IPayloadBaseMetaData, IProjectScope, IOrganisationScope {
-    settingsId: string;
-}
-export interface IWakeupPayload {
-    type: "wakeup";
-    data: IWakeupData;
-}
-export interface IWakeupData {
-    sessionId: string;
-    userId: string;
-    organisation: string;
-    flowId: string;
-    channel: string;
-}
-export interface IResetOrganisationSettingsPayload {
-    type: "resetOrganisationSettings";
-    data: IResetOrganisationSettingsData;
-}
-export interface IResetOrganisationSettingsData {
-    organisation: string;
-}
-export interface IProfileDeactivatedPayload {
-    type: "profileDeactivated";
-    data: IProfileDeactivatedData;
-}
-export interface IProfileDeactivatedData extends IPayloadBaseMetaData {
-    contactIds: string[];
-    organisation: string;
-    deactivated: boolean;
-}
-/**
- * The payload to send to AI to parse an array
- * of example sentences using the COGNIGY.AI NLU System.
- */
-export interface IParseExampleSentencesPayload {
-    type: "parseExampleSentences";
-    data: IParseExampleSentencesData;
-}
-export interface IParseExampleSentencesData extends IPayloadBaseMetaData {
-    /**
-     * An array of example sentences to parse using COGNIGY.AI NLU System.
-     */
-    exampleSentences: string[];
-    /**
-     * An array of lexicon ids that we should generate keyphrases for in the example sentences
-     */
-    lexiconIds: string[];
-    /**
-     * The language of the example sentences so the Cognigy.AI NLU System can
-     * interprete them the right way. Should be a language code like "en", "de"
-     */
-    language: string;
-}
-/**
- * Payload to send to AI to test all intents for a flow
- */
-export interface ITestIntentsPayload {
-    type: "testIntents";
-    data: ITestIntentsData;
-}
-export interface ITestIntentsData extends IPayloadBaseMetaData {
-    flowId: string;
-    entrypoint: string;
-    organisation: string;
-    projectId: string;
-    sentence: string;
-}
-/**
- * Payload returned from AI after testing all intents for a flow
- */
-export interface ITestIntentsReturnValue {
-    scores: IntentScore[];
-    finalIntentName: string;
-    finalIntentScore: number;
-    finalIntentNegated: boolean;
-    finalIntentConfirmationSentence?: string;
-    tiedIntents: IntentScore[] | null;
-    sortedScores?: {
-        [intentName: string]: IntentScore[];
-    };
-}
-/**
- * The payload to send to AI
- * in order to reset all Brains for a flow.
- */
-export interface IResetAllBrainsForFlowPayload {
-    type: "resetAllBrainsForFlow";
-    data: IResetAllBrainsForFlowData;
-}
-export interface IResetAllBrainsForFlowData {
-    /**
-     * The flowId of the flow, whose Brains the user wishes to reset
-     */
-    flowId: string;
-    /**
-     * The organisation that owns the flow.
-     */
-    organisation: string;
-}
-/**
- * The bind to session message is published by the 'service-conversation-manager'
- * as soon as a new message queue was created by an endpoint.
- */
-export interface IBindToSessionQueuePayload {
-    type: "bindToSessionQueue";
-    data: IBindToSessionQueueData;
-}
-export interface IBindToSessionQueueData extends IPayloadBaseMetaData {
-    endpointSessionQueue: string;
-}
-export declare type TAnyChannelDataInput = IAlexaRequestBody | IDialogflowDataInput | ITwilioAutopilotRequestBody | {
-    [key: string]: any;
-};
-/**
- * The data object sent from the Dialogflow
- * endpoint (ci.data)
- */
-export interface IDialogflowDataInput {
-    /** The entire request sent from Dialogflow */
-    request: IDialogflowRequest;
-    /** The original channel where the request was sent from (e.g. Facebook) */
-    originalChannel: string;
-    /**
-     * Information about the user
-     * received during account linking.
-     */
-    accountLinkedUser?: IGoogleAccountLinkedUser;
-}
-export interface IGetNluResultsPayload {
-    type: "getNluResults";
-    data: IGetNluResultsData;
-}
-export interface IGetNluResultsData extends IPayloadBaseMetaData {
-    text: string;
-    intentTrainGroupReferenceId: string;
-    lastChanged: string;
-    organisationId: string;
-    projectId: string;
-    language: string;
-    localeId: string;
-    flowName: string;
-    pipeline: IGetNluPipelineParams;
-    executionState: {
-        ci: object;
-        cc: object;
-        cp: object;
-    };
-    intentMask: string[];
-}
-export interface IGetNluPipelineParams {
-    parseIntents?: boolean;
-    parseSlots?: boolean;
-    parseSystemSlots?: boolean;
-    findType?: boolean;
-}
-interface IMatchedKeyphrase {
-    keyphrase: string;
-    synonym: string;
-    lower: string;
-    count?: number;
-    neg?: boolean;
-    data?: object;
-}
-interface IMatchedKeyphraseContainer {
-    [key: string]: IMatchedKeyphrase[];
-}
-export interface IGetNluResultReturnValue {
-    intent: string;
-    intentId: string;
-    intentFlow: string;
-    intentMapperResults: {
-        [key: string]: any;
-    };
-    slots: IMatchedKeyphraseContainer;
-    systemSlots: ISystemSlots;
-    score: number;
-    type: "Statement" | string;
-    tokens: string[];
-}
-export {};