ZBrain Documentation
  • ZBrain Documentation
    • Components of ZBrain
    • Getting started with ZBrain
    • 📚Knowledge base
      • How to create a knowledge base?
      • Knowledge source
      • Information schema
      • File summary
      • Automated reasoning
      • Retrieval testing
      • Knowledge base settings
    • 📱APP
      • How to create a new app?
      • How to set up and customize your app?
      • How to access the app reporting dashboard?
    • 🤖ZBrain AI agents
      • Get started with agents on ZBrain
      • Deploying pre-built agents
      • Creating custom AI agents
        • Agent setup
        • Define input sources
        • Define Flow
          • Key elements of a Flow
          • Flow Components
            • Activepieces Platform
            • AITable
            • Airtable
            • Amazon S3
            • Amazon SNS
            • Amazon SQS
            • Amazon Textract
            • Apify
            • Apollo
            • Approval
            • Asana
            • Azure Communication Services
            • Azure Cosmos DB
            • Azure Document Intelligence
            • Azure OpenAI
            • Azure Translation
            • Bannerbear
            • Baserow
            • Beamer
            • Bedrock Claude
            • Bettermode
            • Binance
            • Bing Search
            • Blackbaud
            • Bonjoro
            • Box
            • Brevo
            • Brilliant Directories
            • Bubble
            • CSV
            • Calendly
            • Certopus
            • Clearout
            • Clockodo
            • Code
            • Confluence
            • Connections
            • Constant Contact
            • Contiguity
            • Contentful
            • Customer.io
            • Crypto
            • Databricks
            • Data Mapper
            • Date Helper
            • DeepL
            • Delay
            • Discord
            • Discourse
            • Drip
            • Dropbox
            • Dust
            • Facebook Pages
            • Figma
            • Files Helper
            • Flowise
            • Flowlu
            • Formbricks
            • Frame
            • Freshdesk
            • Freshsales
            • GCloud Pub/Sub
            • GenerateBanners
            • GhostCMS
            • GitHub
            • GitLab
            • Gmail
            • Google Calendar
            • Google Contacts
            • Google Docs
            • Google Drive
            • Google Forms
            • Google Gemini
            • Google My Business
            • Google Search
            • Google Search Console
            • Google Sheets
            • Google Tasks
            • Groq
            • Hacker News
            • Heartbeat
            • HubSpot
            • HTTP
            • Image Helper
            • Inputs
            • Instagram for Business
            • Intercom
            • Invoice Ninja
            • Jira Cloud
            • Jotform
            • Kimai
            • Kizeo Forms
            • LeadConnector
            • Line Bot
            • Linear
            • LinkedIn
            • LinkedIn Actions
            • LLMRails
            • Lusha
            • MailerLite
            • Mailchimp
            • Mautic
            • Microsoft Dynamics 365 Business Central
            • Microsoft Dynamics CRM
            • Microsoft Excel 365
            • Microsoft OneDrive
            • Microsoft Outlook Calendar
            • Microsoft Teams
            • Mixpanel
            • MongoDB
            • Notion
            • Odoo
            • OpenAI
            • OpenRouter
            • Pastebin
            • PDF
            • Postgres
            • PostHog
            • Pushover
            • Qdrant
            • Queue
            • Razorpay
            • Router
            • Salesforce
            • SendGrid
            • ServiceNow
            • SFTP
            • SharePoint
            • Slack
            • SMTP
            • Snowflake
            • SOAP
            • Spotify
            • Stability AI
            • Stable Diffusion Web UI
            • Storage
            • Stripe
            • SurrealDB
            • SurveyMonkey
            • Taskade
            • Telegram Bot
            • Text Helper
            • Trello
            • Twilio
            • Twitter
            • Utilities
            • WhatsApp Business
            • WordPress
            • XML
            • YouTube
            • ZBrain
            • Zendesk
            • ZeroBounce
            • Zoho Books
            • Zoho CRM
            • Zoho Invoice
            • Zoom
          • How to Define a Flow?
          • How to Test Each Step in the Flow?
        • Configure Additional Settings
        • Test and Deploy Agents
        • How to access, monitor, and manage agent performance and tasks?
    • Settings
    • 📖API Tutorials
      • 📚Knowledge base
        • Automated Reasoning
      • 📱APP
      • 🤖Agents
Powered by GitBook
On this page
  • 1. Create a new app
  • 2. Configure bot
  • 3. Set appearance
  1. ZBrain Documentation
  2. APP

How to create a new app?

PreviousAPPNextHow to set up and customize your app?

Last updated 1 month ago

1. Create a new app

  • Begin by accessing your platform's dashboard. Locate the ‘Apps’ page from the main menu to manage existing apps or create new ones. To start the app creation process, click the ‘Create’ button displayed on the top right corner of the ‘Apps’ page.

  • Select the type of app that best fits your needs from the available options. Your choice will determine the app's basic structure and capabilities.

  • Then, determine who will have access to your app:

    • Public app: The app link will be public, and anyone with the link can use the app. Ideal for applications meant for a broad audience.

    • Private app: The app link will be private, and only those with the link can access the application. Suitable for internal or restricted use cases.

  • Choose an orchestration method from the following options:

    • Knowledge Base (Basic): In this method, the application relies on the provided knowledge base to answer queries. This is a straightforward method using pre-existing information.

    • Flow (Advanced): This method allows you to design custom flows for handling queries, allowing more complex interactions and processes. This option is ideal for advanced users who need specific logic and sequences.

  • Next, enter a unique name for your application and provide a description if desired. This name and description help identify the app and can be changed later if needed.

2. Configure bot

Connecting and managing knowledge base(s) in your app

  • Click the ‘Add’ button to choose one or multiple knowledge bases you wish to connect to your app.

  • You can use the search function to quickly find specific knowledge bases from the list. After selecting the knowledge base(s), click ‘Add’ to connect them.

  • The connected knowledge base(s) will immediately appear in the table with their names. To enable the Advanced Reasoning feature, tick the checkbox and choose a schema from the available options for the connected knowledge base to conduct detailed data queries.

  • To remove a connected knowledge base, slide the bar to the right and click the trash icon to delete it.

App interaction guidelines and instructions

  • Define particular instructions or guidelines that the app must adhere to during user interactions. These instructions may encompass the following: Be specific and detailed: Provide clear and comprehensive answers to user queries. Ensure that responses address specific aspects of the question or topic raised. Use natural language: Interact conversationally with users, using language that feels natural and engaging. Avoid overly technical jargon unless necessary. Tailor responses to context: Adapt answers based on the conversation's context. Use previous interactions to provide more relevant and personalized responses.

App interaction guidelines and instructions

  • Define particular instructions or guidelines that the app must adhere to during user interactions. These instructions may encompass the following: Be specific and detailed: Provide clear and comprehensive answers to user queries. Ensure that responses address specific aspects of the question or topic raised. Use natural language: Interact conversationally with users, using language that feels natural and engaging. Avoid overly technical jargon unless necessary. Tailor responses to context: Adapt answers based on the conversation's context. Use previous interactions to provide more relevant and personalized responses.

  • Click ‘View all settings’ to access additional parameters and their preset settings:

    • Top P: Also known as nucleus sampling, controls response diversity by considering only the top probability mass tokens.

    • Presence penalty: Adjusts the likelihood of introducing new topics by discouraging repeated words.

    • Frequency penalty: Reduces the probability of repetitive phrases by penalizing frequent token occurrences.

    • Context max token: Defines the limit for contextual memory, determining how much past conversation is retained.

    • Response max token: Specifies the maximum token count for each AI-generated response.

    • Model: The specific AI model used for generating responses.

    • Guardrails: Safety constraints applied to AI-generated responses to ensure appropriate content.

    • Static input: Adds predefined text to responses for consistent context.

    • Rerank: Improves search result relevance by prioritizing the most relevant responses.

    • Follow-up conversation: Enables the model to recall past interactions within the same session.

    • Source: Allows the model to summarize documents as part of its responses.

Editing model parameters

  1. Click on the pencil icon to edit settings.

  2. Select the preferred model.

  3. Adjust parameters using the provided controls:

    • Click ‘Load Presets’ and select Creative, Balanced, or Precise.

      • Load Presets provides predefined configuration settings optimized for different response styles:

        • Creative: Generates more imaginative and diverse responses.

        • Balanced: Maintains a mix of creativity and precision.

        • Precise: Focuses on accuracy and concise responses.

  • Use the slider to configure each parameter based on your preferred output behavior.

    Refer to the definitions above for guidance on how each parameter affects responses.

  1. Enable or disable features as needed:

    • Reranking model: Enhances the relevance of search results.

    • Follow-up conversation: Allows the model to remember previous conversations within a session.

    • Guardrails (Optional): Applies safety constraints to AI responses.

    • Static input (Optional): Adds static text for consistent context.

    • Source (Optional): Allows the model to summarize documents in responses.

Saving and reverting settings

  • Update settings: Click to save customized configurations for future use.

  • Default settings: Click to revert to default configurations.

Advanced manual configuration

  • Users can also make manual changes by clicking the ‘Edit’ button in the manual configure box.

  • This option is applicable only for advanced users.

Proceeding to the next step

  • Click ‘Next’ to move forward to the set appearance page.

3. Set appearance

  • You can customize the visual and interactive aspects of your app by configuring the following:

    • Welcome message: Add a welcome message that users will see when they first access the app.

    • App name and description: Provide a name and a brief description of your app.

    • Sample questions: Add up to nine sample questions to guide users on how to interact with the bot. You can also generate these questions automatically.

    • Upload logo and app theme: Enhance your app’s branding by uploading a logo and selecting a theme.

    • Bot name and icons: Customize the bot's name and icons to match your app’s branding.

  • After clicking ‘Done,’ your app will be created, and you'll be directed to an overview page to manage various aspects of your application. Alternatively, click ‘I will do later’ to set the appearance at a later time.

📱