RapidCanvas Docs
  • Welcome
  • GETTING STARTED
    • Quick start guide
    • Introduction to RapidCanvas
    • RapidCanvas Concepts
    • Accessing the platform
  • BASIC
    • Projects
      • Projects Overview
        • Creating a project
        • Reviewing the Projects listing page
        • Duplicating a Project
        • Modifying the project settings
        • Deleting Project(s)
        • Configuring global variables at the project level
        • Working on a project
        • Generating the about content for the project
        • Generating AI snippets for each node on the Canvas
        • Marking & Unmarking a Project as Favorite
      • Canvas overview
        • Shortcut options on canvas
        • Queuing the Recipes
        • Bulk Deletion of Canvas Nodes
        • AI Guide
      • Recipes
        • AI-assisted recipe
        • Rapid model recipe
        • Template recipe
        • Code Recipe
        • RAG Recipes
      • Scheduler overview
        • Creating a scheduler
        • Running the scheduler manually
        • Managing schedulers in a project
        • Viewing the schedulers in a project
        • Viewing the run history of a specific scheduler
        • Publishing the updated data pipeline to selected jobs from canvas
        • Fetching the latest data pipeline to a specific scheduler
        • Comparing the canvas of the scheduler with current canvas of the project
      • Predictions
        • Manual Prediction
        • Prediction Scheduler
      • Segments and Scenarios
      • DataApps
        • Model DataApp
        • Project Canvas Datasets
        • Custom Uploaded Datasets
        • SQL Sources
        • Documents and PDFs
        • Prediction Service
        • Scheduler
        • Import DataApp
    • Connectors
      • Importing dataset(s) from the local system
      • Importing Text Files from the Local System
      • Connectors overview
      • Connect to external connectors
        • Importing data from Google Cloud Storage (GCS)
        • Importing data from Amazon S3
        • Importing data from Azure Blob
        • Importing data from Mongo DB
        • Importing data from Snowflake
        • Importing data from MySQL
        • Importing data from Amazon Redshift
        • Importing data from Fivetran connectors
    • Workspaces
      • User roles and permissions
    • Artifacts & Models
      • Adding Artifacts at the Project Level
      • Adding Models at the Project Level
      • Creating an artifact at the workspace level
      • Managing artifacts at the workspace level
      • Managing Models at the Workspace Level
      • Prediction services
    • Environments Overview
      • Creating an environment
      • Editing the environment details
      • Deleting an environment
      • Monitoring the resource utilization in an environment
  • ADVANCED
    • Starter Guide
      • Quick Start
    • Setup and Installation
      • Installing and setting up the SDK
    • Helper Functions
    • Notebook Guide
      • Introduction
      • Create a template
      • Code Snippets
      • DataApps
      • Prediction Service
      • How to
        • How to Authenticate
        • Create a new project
        • Create a Custom Environment
        • Add a dataset
        • Add a recipe to the dataset
        • Manage cloud connection
        • Code recipes
        • Display a template on the UI
        • Create Global Variables
        • Scheduler
        • Create new scenarios
        • Create Template
        • Use a template in a flow notebook
      • Reference Implementations
        • DataApps
        • Artifacts
        • Connectors
        • Feature Store
        • ML model
        • ML Pipeline
        • Multiple Files
      • Sample Projects
        • Model build and predict
    • Rapid Rag
  • Additional Reading
    • Release Notes
      • May 14, 2025
      • April 21, 2025
      • April 01, 2025
      • Mar 18, 2025
      • Feb 27, 2025
      • Jan 27, 2025
      • Dec 26, 2024
      • Nov 26, 2024
      • Oct 24, 2024
      • Sep 11, 2024
        • Aug 08, 2024
      • Aug 29, 2024
      • July 18, 2024
      • July 03, 2024
      • June 19, 2024
      • May 30, 2024
      • May 15, 2024
      • April 17, 2024
      • Mar 28, 2024
      • Mar 20, 2024
      • Feb 28, 2024
      • Feb 19, 2024
      • Jan 30, 2024
      • Jan 16, 2024
      • Dec 12, 2023
      • Nov 07, 2023
      • Oct 25, 2023
      • Oct 01, 2024
    • Glossary
Powered by GitBook
On this page
  1. BASIC
  2. Projects
  3. DataApps

Documents and PDFs

PreviousSQL SourcesNextPrediction Service

Last updated 1 month ago

Creating Custom DataApp using Documents and PDFs as an input

Use this procedure to create a custom DataApp using documents and PDFs an an input. Note that these DataApps are model-independent, so no project model is required to create them.

  1. Hover over the menu icon and select Projects

  2. Select the project for which you want to create DataApps and click the DataApps icon from the project level navigation.

  3. Click the plus icon and select Custom DataApp. This opens the Create DataApp page.

  1. Specify this information on the Details tab.

  2. Select the input type as Documents and PDFs.

  3. Add the description of the DataApp that explains about it.

  4. By default, the environment selected during project creation is applied. However, you have the flexibility to choose a different environment for running your DataApps.

  5. Provide the name of the DataApp on the breadcrumb.

  6. Click to upload an image to display on the DataApp card that you see on the DataApps page.

  7. Turn ON or OFF the following toggles in the Consumer Permissions section to control what actions users with the DataApp Consumer role can perform:

    • Allow New Chat Creation: Turn ON to allow consumers to create new chats in the AskAI tab.

    • Allow Chat Deletion: Turn ON to enable consumers to delete chat threads.

    • Allow Input Selection: Turn ON to allow consumers to select input datasets or reports for chats in AskAI.

    • Show Input Name & Details: This option is disabled by default and is automatically enabled when Allow Input Selection is turned OFF. When enabled, consumers can view input data and its details. Ensure at least one input is selected in the chat for consumers to ask prompts related to the selected input. If a consumer deletes a chat, the same input will automatically be transferred to the new chat, ensuring continuity and ease of use.

    • Allow Documents Download and Preview: Turn ON to allow consumers to download and preview documents. Disabling this toggle will prevent them from downloading and previewing the documents.

    • Show Model Response Code: Turn ON to allow consumers to view the model-generated code for their queries.

    • Hide Side Panel: If toggles such as Allow New Chat Creation, Allow Input Selection, and Allow Chat Deletion are turned OFF, the side panel will no longer be visible.

If you want to preview how the DataApp's consumer interface appears after adjusting these toggles, use the Consumer Preview option. You can find this option under the Actions drop-down on the DataApps page. This allows you to see the interface from a consumer’s perspective and ensure that the changes reflect as expected.

  1. Click the Settings tab and specify this information.

  2. Select a model that you want to use in the Documents and PDFs DataApp. Possible values:

    • OpenAI GPT-4 Turbo

    • OpenAI GPT-4o (by default this is selected)

    • Azure OpenAI GPT-4o

    • Anthropic Claude 3.5 Sonnet (beta)

  3. Toggle ON the Enable Response Caching option to return the same response for the identical queries despite asking multiple times.

  4. Toggle ON the Show Model Response Code option to view the code generated by the model in response to the queries.

  5. Select Access Control to manage access to chats and charts generated within the DataApp. The available options are:

    • Team Access: Allows all users within the tenant to view chats and charts in the DataApp.

    • Individual Access: Restricts visibility of chats and charts to users who created them. For example, if User A creates Chat A and Chart C, only User A can view these.

  6. Enter Model controls in the text box to provide specific context to the AI guide. This helps in aligning the AI-generated responses more closely with the user’s particular use case.

  7. When the Enable Insights Model toggle is turned on, two additional configuration options appear:

    • Insights Model: Select the model that will interpret and generate insights from the dataset or chart outputs.

    • System Message: Optionally provide contextual guidance to the model, helping it tailor responses based on your specific use case or analytical objectives.

  8. Turn ON or OFF the following toggles in the Consumer Permissions section to control what actions users with the DataApp Consumer role can perform:

    • Allow New Chat Creation: Turn ON to allow consumers to create new chats in the AskAI tab.

    • Allow Chat Deletion: Turn ON to enable consumers to delete chat threads.

    • Allow Input Selection: Turn ON to allow consumers to select input datasets or reports for chats in AskAI.

    • Show Input Name & Details: This option is disabled by default and is automatically enabled when Allow Input Selection is turned OFF. When enabled, consumers can view input data and its details. Ensure at least one input is selected in the chat for consumers to ask prompts related to the selected input. If a consumer deletes a chat, the same input will automatically be transferred to the new chat, ensuring continuity and ease of use.

    • Allow Slash Options: Turn ON to enable consumers use slash commands in the AskAI query box to specify the desired output type—datasets, text, charts, or prompt suggestions—allowing for more precise queries and seamless interaction with data

    • Show User Charts Tab: Turn ON to allow consumers to view the User Charts tab.

    • Show Model Response Code: Turn ON to allow consumers to view the model-generated code for their queries.

    • Hide Side Panel: If toggles such as Allow New Chat Creation, Show User Charts Tab, Allow Input Selection, and Allow Chat Deletion are turned OFF, the side panel will no longer be visible.

Adding Starter Prompts in DataApps

Starter prompts help new DataApp users get started by providing predefined queries on the AskAI page. Users can add up to 10 prompts to guide interactions with AI-powered DataApps, making it easier for business users to formulate relevant queries.

Steps to Add Starter Prompts

  1. Click the Starter Prompts tab.

  2. In the Create New Prompt section, enter the prompt you want to display on the AskAI page.

  3. Click +Add Prompt after each entry. You can add up to 10 prompts per DataApp.

Once added, these prompts will appear in the AskAI window, providing users with helpful starting points for their queries.

Note: Starter prompts can be added for all types of custom DataApps, except for model DataApps and imported DataApps.

  1. Click Create. The DataApp card is created.

  1. Click on the DataApp card to launch the AskAI DataApp. The AskAI chat window appears.

  2. To upload documents, click Upload Documents, which supports formats such as PDF, DOC, DOCX, TXT, and Markdown. This option allows you to browse and upload files directly from your local system. Once uploaded, you can begin querying using AskAI. You can upload up to 50 documents at a time.

The Recent Documents tab displays recently uploaded documents, while the Select from Artifacts tab shows a list of folders in the Artifacts library. Clicking on a folder shows the files within it, allowing you to select the desired file for querying. However, only artifact files in PDF, DOC, DOCX, TXT, or Markdown formats can be selected for this purpose.

  1. Enter the query in the query box. The generated output will be in the text format. You can:

  • Copy the answer using the Copy Answer option.

  • View the generated code by selecting the View Code option where you can also view the explanation for each line of code.

Perform the following actions clicking the Actions drop-down:

  • Copy the dataapps URL to share with the other business users, using the Copy option.

  • Open the dataapps on a new tab, using the Open in New Tab option.

  • View logs of DataApps to debug issues, using the Logs option.

  • Delete the DataApp that is no longer required, using the Delete option.

  • Customize the branding appearance of your DataApp, using the Branding option. This opens the Branding modal. Enter your desired title in the DataApp Title field, then use the Upload from Computer option to upload your logo. Once you have added the title and logo, click Save to apply the changes. The customized title and logo will now appear on the AskAI page and will also be visible when the DataApp is opened in a new tab.

  • As a DataApp power user or admin, you can preview the consumer interface using the Consumer Preview option. This option is available only when the DataApp is running.

Toggle ON the Enable Insights Model to activate reasoning support for dataset and chart outputs in response to user queries on the AskAI tab. For more information, refer section.

If you want to preview how the DataApp's consumer interface appears after adjusting these toggles, use the Consumer Preview option. You can find this option under the Actions drop-down on the DataApps page. This allows you to see the interface from a consumer’s perspective and ensure that the changes reflect as expected. See .

Modify the DataApp details, using the Edit option. For more details, see section.

Configure the shutdown time of the DataApp, using the Config option. See section for more details.

Previewing the Consumer Interface
Editing a DataApp
configuring shutdown time of the DataApp
datasetinputdoc
Enabling the Insights Model to View Contextual Insights in AskAI