API Functions

// Parse CognigyScript as text
const parsedText = api.parseCognigyScript(
"Hello {{cc.text}}, welcome!",
false
);
api.say(parsedText);

// Parse CognigyScript as a condition
const parsedCondition = api.parseCognigyScript(
"{{input.currentTime.year > 2024}}",
true
);

if (parsedCondition === "true") {
api.say("Condition is true");
} else {
api.say("Condition is false");
}

const parseCognigyScriptCondition = api.parseCognigyScriptCondition(
"{{input.currentTime.year > 2024}}"
);

api.say(`${parseCognigyScriptCondition}`);

const output = api.parseCognigyScriptText("Hello {{cc.text}}, welcome to {{cc.city}}!");
api.say(`The current state is: ${output}`);

// Reactivate a previously deactivated Profile
api.activateProfile();

api.addContactMemory("ppl");

// Deactivate a Contact Profile
api.deactivateProfile();

// Delete the Contact Profile
api.deleteProfile();

api.mergeProfile("c-89374201a7bd5a9e4");

// Update the 'email' field of the current Contact Profile
api.updateProfile("email", "[email protected]");

// Update a custom string field
api.updateProfile("subscriptionStatus", "active");

// Update a numeric field
api.updateProfile("loyaltyPoints", 120);

// Update a boolean field
api.updateProfile("marketingConsent", true);

// Simple mode: replaces existing value
api.addToContext("user.city", "Berlin", "simple");
// Context: { user: { city: "Berlin" } }

api.addToContext("user.city", "Munich", "simple");
// Context: { user: { city: "Munich" } }

// Array mode: appends to an array
api.addToContext("user.purchases", "book", "array");
// Context: { user: { purchases: ["book"] } }

api.addToContext("user.purchases", "laptop", "array");
api.addToContext("user.purchases", "coffee", "array");
// Context: { user: { purchases: ["book", "laptop", "coffee"] } }

api.deleteContext("user.city");

api.getContext("user.profile.name");

[
    { "source":"user", "text":"hello" },
    { "source":"bot", "text":"You said: hello" },
    { "source":"user", "text":"you are an ai agent" },
    { "source":"bot", "text":"You said: you are an ai agent" },
    { "source":"user", "text":"show transcript" }
]

- USER: hello
- BOT: You said: hello
- USER: you are an ai agent
- BOT: You said: you are an ai agent
- USER: show transcript

// Get the transcript
const transcriptJson = api.getConversationTranscript({ turnLimit: 5 });

// Convert the JSON array to a string
const transcriptJsonPrint= JSON.stringify(transcriptJson, null, 2);

// Send it to the user
api.say(transcriptJsonPrint);

// Get the transcript
const transcriptString = api.getConversationTranscript("string", { turnLimit: 1 });

// Send it to the user
api.say(transcriptString);

// Simple mode: remove the entire key
api.removeFromContext("user.city", null, "simple");
// Context: { user: { city: undefined } }

// Array mode: remove specific values from an array
api.addToContext("user.purchases", "book", "array");
api.addToContext("user.purchases", "laptop", "array");
api.addToContext("user.purchases", "coffee", "array");

// Remove "laptop" from the purchases array
api.removeFromContext("user.purchases", "laptop", "array");
// Context: { user: { purchases: ["book", "coffee"] } }

// Remove all context data added during the conversation
api.resetContext();

api.setContext("user.city", "Berlin");

const decoded = api.base64Decode("SGVsbG8sIFdvcmxkIQ==");
api.say(`Decoded string: ${decoded}`);
// Output: "Hello, World!"

const encoded = api.base64Encode("Hello, World!");
api.say(`Encoded string: ${encoded}`);
// Output: "SGVsbG8sIFdvcmxkIQ=="

api.addConditionalEntrypoint({
entrypoint: "c40c50f3-2f51-422c-8a3e-748e7cc92ed0",
retentionTime: 2,
condition: "input.text.includes('@')"
});

// Imagine you previously used api.setNextNode("fallback-node") to redirect the Flow.
// Now, you want to clear that override so the Flow continues as originally defined.

api.resetNextNodes();

// The current Node is executing inside a Flow, and you want to control which Node should be executed next based on some logic.
// In this example, the execution will jump to a Node with the nodeId "c4c5c267-55d8-44ae-a123-f351d237f496" immediately after the current Node finishes.

api.setNextNode("c4c5c267-55d8-44ae-a123-f351d237f496");

// To continue the conversation in a different Flow after the current Node, specify both the target nodeId and the flowId.
// The Node with nodeId "c4c5c267-55d8-44ae-a123-f351d237f496" must be marked as an Entrypoint in the target Flow with flowId "67f511b11acdc139f91946b8".
// Execution will jump directly to that Node after the current one finishes.

api.setNextNode("c4c5c267-55d8-44ae-a123-f351d237f496", "67f511b11acdc139f91946b8");

api.stopExecution();

api.thinkV2( "Hello, how's the weather?", { location: "Berlin", units: "Celsius" });

api.addToInput("username", "John Doe");

// Send text with additional data
api.say("Hello, this is a message from the Code Node!", { customData: 123 });

// `api.output` is an alias of `api.say`
api.output("Hello, this is a message from the Code Node!", { customData: 123 });

api.completeGoal("Order Pizza");

api.emitToOpsCenter({
    projectId: "6874becb018c552bc267cc51",
    title: "Something went wrong",
});

{
    "llmDisplayName": string,
    "providerType": string,
    "modelType": string,
    "usage": {
    "inputTokens": number,
    "outputTokens": number
    }
}

api.getLLMTokenUsageForSession();

api.log("info", "This is an informational message.");
api.log("error", "An error occurred during Flow execution.");
api.log("debug", "Debugging details for Flow execution.");

// Log a simple string
api.logDebugMessage("Flow started successfully", "Flow Info");

// Log multiple variables together
const sessionInfo = { sessionId: "abc123", timestamp: new Date().toISOString() };
const userData = { name: "Alice", age: 25 };

// Combine objects into one for logging
api.logDebugMessage(JSON.stringify({ sessionInfo, userData }, null, 2), "Session & User Info");

api.setSensitiveLoggingSettings({
    maskLogging: true, // Mask sensitive information in conversation logs
    maskAnalytics: true, // Mask sensitive information in analytics and Insights
    maskIPAddress: true, // Optional: mask user IP addresses
    disableConversations: true, // Disable conversation logging entirely
    disableIntentTrainer: true // Disable logging for the Intent Trainer
    }, "trace-12345"); // Optional trace ID for debugging

// Track that the user reached the "Checkout" step
api.trackAnalyticsStep("Checkout");

// Get the current State of the Flow
const currentState = api.getState();

// Send the State to the user
api.say(`The current state is: ${currentState}`);

api.resetState();

// Set the conversation state to "awaiting_input"
api.setState("awaiting_input");

// Verify by getting the current state
const currentState = api.getState();
api.say(`The current state is: ${currentState}`);

// Add a new keyphrase to the existing Lexicon
api.addLexiconKeyphrase(
  "6942550bf16d8343c6f1adec",
  "password reset",
  ["account", "security"], // tags
  ["reset password", "forgot password"], // synonyms
  {
    priority: "high",
    source: "dynamic",
  }
);

api.evaluateRule({
    left: "hello world",
    operand: "contains",
    right: "hello"
});

api.handover({
    text: "Connecting you to a human agent...",
    cancelIntent: "CancelHandover",
    unavailable: "No agents are available at the moment.",
    unsupportedChannel: "This channel doesn't support handover.",
    quickReply: "Talk to an agent",
    chatwootInboxId: "chatwoot_123",
    liveAgentInboxId: "liveagent_456"
});

api.setLocaleReferenceId("b4dc8ff5-bd05-467a-a281-2514122c4aa2")

api.setRating({
    rating: 1,
    comment: "The conversation was helpful."
});

// Set the session timezone offset to UTC+4
api.setTimezoneOffset(4);