How to Use

1 - Invite your teams

Invite your team and start collaboration in your workplace. By bringing everyone together, you enforce productivity and seamless communication, foster creativity, and facilitate a more connected and efficient working environment.

2 -Select AI Chatflow from Marketplace

Start deploying AI application for example Custom ChatGPT for your data Just connect your data sources and get a ChatGPT-like chatbot for your data. Then add it as a widget to your website or chat with it through our integrations or API.Test your AI chatflow with the chat interface on convosuite, edit and share it, go live in a minutes.

3- Unlock productivity

Empower your team to focus on significant tasks and reduce busywork with Convosuite. This tool efficiently manages emails, replies, and integrates seamlessly with Teams or Slack. It's like ChatGPT Plus but with the most powerful integrated plugins, allowing for real-time task management, AI image generation, GPT-4 access, and compatibility with various file formats. With Convosuite, you can turn ideas into apps in minutes, handle various files such as audio, video, docs, CSV, PDF, and presentations, and create content with the latest information.

4 - Promts Engineering Tools

With our advanced prompts engineering templates, you can create compelling job ads, write engaging blog posts, and craft effective social media ads that drive conversions. You can even generate email marketing templates from URLs, as well as write code.

5- Advanced AI Dashboard

This will display user activity and growth, usage statistics, Top active users, OpenAI usage, tracking total token, consumption, file and media interactions, usage of integrated Google Search and Dall-E capabilities, estimated time savings, productivity increase, sentiment analysis, and error rates or issues.

Now after you select your chatbot template and you have tested your chatflow with the chat interface on Convosuite, you want to "export" it out to be able to use with other applications. Convosuite provides 2 ways to do that:

• API

• Embed

API

You can use the chatflow as API and connect to frontend applications.

You also have the flexibility to override input configuration with overrideConfig property.

An example of API call using Postman:

Key	Description	Type	Required
question	User's question	string	Yes
overrideConfig	Override existing flow configuration	object	No
history	Provide list of history messages to the flow	array	No

// Example body request
{
    "question": "What's my name?",
    "history": [
        {
            "message": "Hello, how can I assist you?",
            "type": "apiMessage"
        },
        {
            "type": "userMessage",
            "message": "Hello I am Bob"
        },
        {
            "type": "apiMessage",
            "message": "Hello Bob! how can I assist you?"
        }
    ],
    "overrideConfig": {
        "returnSourceDocuments": true
    }
}

Flow with Document Loaders

If the flow contains Document Loaders, the API looks slightly different. Instead of passing as JSON body, form-data is being used. This allows you to upload any files to the API.

Note: It is user's responsibility to make sure the file type is compatible with the expected file type from document loader. For example, if a Text File Loader is being used, you should only upload file with .txt extension.

An example of API call with form-data using Postman:

Streaming

Convosuite also support streaming back to your front end application when the final node is a Chain or OpenAI Function Agent.

1. Install socket.io-client to your front-end application

yarn add socket.io-client

or using npm

npm install socket.io-client

Refer official docs for more installation options.

1. Import it

import socketIOClient from 'socket.io-client'

1. Establish connection

const socket = socketIOClient("http://localhost:3000") //flow url

1. Listen to connection

import { useState } from 'react'

const [socketIOClientId, setSocketIOClientId] = useState('');

socket.on('connect', () => {
  setSocketIOClientId(socket.id)
});

1. Send query with socketIOClientId

async function query(data) {
    const response = await fetch(
        "http://localhost:3000/api/v1/prediction/<chatflow-id>",
        {
            method: "POST",
            body: data
        }
    );
    const result = await response.json();
    return result;
}

query({
  "question": "Hey, how are you?",
  "socketIOClientId": socketIOClientId
}).then((response) => {
    console.log(response);
});

1. Listen to token stream

socket.on('start', () => {
  console.log('start');
});

socket.on('token', (token) => {
  console.log('token:', token);
});

socket.on('sourceDocuments', (sourceDocuments) => {
  console.log('sourceDocuments:', sourceDocuments);
});

socket.on('end', () => {
  console.log('end');
});

1. Disconnect connection

socket.disconnect();

Embed

You can also embed a chat widget to your website.

Simply copy paste the embedded code provided to anywhere in the <body> tag of your html file.