DOCSEARCHbyAlgolia
Submit Docs

Suppa Documentation

website·Indexed 32 days ago

https://docs.suppa.ai

Guides for installing and configuring Suppa AI assistants across various platforms, including website builders like WordPress, Wix, Shopify, and Webflow, and frameworks such as React, Next.js, Vue, and Angular. Includes instructions for managing the knowledgebase via file, URL, or plain text uploads, and extending assistant capabilities through custom API actions and Canvas flow nodes.

Tokens
12.5K
Snippets
29
Records
89
Agent score
55%

What's inside Suppa

  1. Overview of upcoming Suppa Plugin Integrations

    Suppa is developing a library of pre-built Plugin Integrations to simplify the addition of common business tools. The following integrations are planned (Status: Coming Soon):

    • CRM: Salesforce, HubSpot, Zoho CRM.
    • Project Management: Trello, Asana, JIRA.
    • Communication Platforms: Slack, Microsoft Teams, Discord.
    • E-commerce Platforms: Shopify, WooCommerce, Magento, IKAS.

  2. Overview of the Branch node in Canvas flow

    The Branch node is used to create conditional paths in a Canvas flow. It evaluates user input or conditions and directs the flow to different paths based on the result. The node configuration is divided into three main tabs: Selection (defining the branching logic), Branches (defining the actual paths), and Variables (managing the output of the branch).

  3. Overview of Suppa AI Digital Assistant

    Suppa is an AI digital assistant platform used to automate customer support, streamline sales processes, and create interactive FAQ systems. It leverages Large Language Models (LLMs) and intent recognition to provide context-aware responses across multiple channels, including websites, mobile apps, and social media. Key capabilities include knowledgebase management, customizable assistant personalities, and real-time interaction analytics.

  4. Overview of the Canvas UI

    The Canvas is a drag-and-drop visual programming interface used to build conversational AI flows. Key UI elements include:

    • Fit to View: Adjusts the canvas to fit all nodes.
    • Zoom Level: Controls the magnification of the canvas.
    • Display Nodes: Toggles the node sidebar.
    • Undo/Redo: Reverts or reapplies recent actions.
    • Warnings Checklist: Displays flow-related warnings and errors.
    • Preview: Tests the flow in a simulated conversation.
    • Deploy: Publishes the flow to make it live.
    • Flow Status: Indicates if the flow is a 'draft' or 'published'.
    • Current Flow: Shows the name of the active flow.
    • Save and Exit: Saves progress and closes the editor.

  5. Overview of Suppa Actions

    Actions in Suppa are custom API endpoints integrated into the digital assistant platform. They extend the AI's capabilities by allowing it to perform specific tasks, retrieve real-time information from internal systems (like CRMs or databases), and trigger backend processes. This bridges the gap between the AI's general capabilities and a company's unique business data and workflows.

  6. Query a knowledge base using the Knowledgebase node

    The Knowledgebase node is used to retrieve information from a knowledge base based on user input. It is typically used to answer frequently asked questions or fetch data from a database. The node configuration is split into three primary areas: Lookup, Access, and Variables.

  7. Configure the Start node in a Canvas flow

    The Start node serves as the mandatory entry point for every Canvas project. It initializes flow execution and handles the initial user greeting. To function correctly, the Start node must be connected to at least one other node in the flow.

  8. Understand the purpose of the Suppa Knowledgebase

    The Knowledgebase is a structured collection of information and data that acts as the foundation for Suppa's responses and decision-making. It enables the AI to interpret user input, provide accurate domain-specific information, maintain consistency across interactions, and scale to handle a wide range of customer queries.

  9. Add content to the Suppa knowledgebase

    To add new items to the Suppa knowledgebase, navigate to the 'Knowledgebase' section of the dashboard and click the 'Add Item' button. You can provide content via three input types:

    1. File: Upload one or more files.
    2. Link: Provide a full URL to the content.
    3. Text: Type or paste plain text directly into the field.

    After entering the content, click 'Confirm' to finalize. Items are not immediately available; they must be processed and indexed by Suppa. You can monitor the processing status in the 'Knowledgebase' section of the dashboard.

  10. Implement Image Generation Flow in Suppa Canvas

    To create a flow that generates images using FLUX Schnell:

    1. Capture Prompt: Use an Input node to ask the user for an image prompt.
    2. Configure API Call: Add an API Call node and select the FLUX Schnell action.
      • Headers: Set Authorization to Key {YOUR_API_KEY} and Content-Type to application/json.
      • Request Body: Map the prompt field to the variable from the Input node. Optionally set image_size (e.g., landscape_4_3).
    3. Extract Result: Use a JSONPath expression in the response settings to extract the image URL from the images array.
    4. Display Image: Connect a Message node and set the message content to the extracted image URL variable.

  11. Implement pattern-based branching with Regex

    The Regex method uses regular expressions to match patterns in the Value field. If the input matches the defined regex, the flow proceeds on the corresponding path.

    Requirement: Regular expressions must be compatible with the JavaScript regex engine.

  12. Install Suppa in a Remix application

    To integrate Suppa into a Remix project, add the Suppa integration script to the <head> section of the root layout file located at app/root.tsx. Replace YOUR_SUPPA_API_KEY with your actual Suppa API key.
    import { Meta, Links, Scripts, LiveReload } from "@remix-run/react";

export default function App() {
  return (
    <html lang="en">
      <head>
        <Meta />
        <Links />
        <script
          src="https://app.suppa.ai/integration/script.js"
          data-api-key="YOUR_SUPPA_API_KEY"
        />
      </head>
      <body>
        <Outlet />
        <Scripts />
        <LiveReload />
      </body>
    </html>
  );
}