Document Vector Database

Overview

The Document Vector Database Connected System enables Large Language Models (LLMs) to answer user submitted questions based on Appian Knowledge Center Documents. By uploading documents to this connected system, users can perform semantic searches to pinpoint the most pertinent content related to their questions. The Connected System also boasts Client APIs tailored for the AI Knowledge Assistant Component. This allows the AI Knowledge Assistant Component to deliver AI generated answers to user inquiries sourced from documents stored in the database, as well as general questions.

Key Features & Functionality

  1. Upload Document - Uploads and stores the documents and its vector in the database.
  2. List Documents - Provides us the list of documents uploaded in the database.
  3. Database Operations
    1. Delete Documents - Enables us to delete the documents that are uploaded in the database.
    2. Sync Documents - Updates the existing documents in the database with the latest version of the document available in the Appian Knowledge Center.
    3. Change Database Password - Changes Database password.
  4. Query Documents - Get relevant pieces of content from documents for the given prompt.
  5. Generate Response - Perform search in the given documents and generate ChatGPT response for the given prompt.
  6. Client APIs for AI Knowledge Assistant component for fetching document details, chat completions, document querying, and uploading new documents to the database.

Notes:

  • Download the AI Knowledge Assistant, a sophisticated chatbot designed to perform semantic searches across your documents and provide precise answers to your queries.
  • This plugin is not supported for HA environments.
Anonymous
  • You can select the database name yourself, simple choose a name that makes sense.

  • What will be the Database Name (Table values)? which will be used in the creation of the Database file in Appian while creating a connected system.

  • v3.2.3 Release Notes
    1. Security Patch Updated.
    2. Implemented Retry mechanism when the database is locked in HA environments.
    3. Included token usage information in the client APIs and servlets.
    4. Added the user information to the OpenAI and Azure OpenAI request for monitoring purpose.
    IMPORTANT NOTE: If you are using this plugin in production, open a support case and ask to increase Heap Max for app server by 1GB. This will increase query performance and allow the plugin to handle a larger number of concurrent users.

  • v3.2.2 Release Notes
    • Added 128 k tokens option for Max Tokens input for Azure authentication in the Connected System configuration.
    • Minor Bug fixes
    IMPORTANT NOTE: If you are using this plugin in production, open a support case and ask to increase Heap Max for app server by 1GB. This will increase query performance and allow the plugin to handle a larger number of concurrent users.

  • v3.2.1 Release Notes
    • Minor Bug Fixes.
    • Security patch updated.

  • v3.2.0 Release Notes
    1. Introduced a new input in the connected system configuration to enable/disable Response streaming in the AI Knowledge Assistant component.
    2. Added new Client APIs for uploading documents and performing chat completions. If the Disable Streaming Response is true, the AI Knowledge Assistant component will use the Client APIs for uploading documents and chat completions.
    3. Security patch updated.

  • v3.1.2 Release Notes
    • Security patch updated.

  • v3.1.1 Release Notes
    1. Bug fixes.
    2. Security patch updated.

    IMPORTANT NOTE: If you are using this plugin in production, open a support case and ask to increase Heap Max for app server by 1GB. This will increase query performance and allow the plugin to handle a larger number of concurrent users.

  • v3.1.0 Release Notes
    1. Introduced a new integration - Grouping Integration enabling the grouping of text entries into specified categories.
    2. Enhanced usability by restricting editing of the embedding model and Database constant name in the Connected System configuration only during the initial creation phase of the Connected System.

    IMPORTANT NOTE: If you are using this plugin in production, open a support case and ask to increase Heap Max for app server by 1GB. This will increase query performance and allow the plugin to handle a larger number of concurrent users.

  • v3.0.1 Release Notes
    1. Bug fixes
    2. Made all the fields in Connected System as import customizable.
    IMPORTANT NOTE: If you are using this plugin in production, open a support case and ask to increase Heap Max for app server by 1GB. This will increase query performance and allow the plugin to handle a larger number of concurrent users.