Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
ffdf6e6
Update features-core.mdx
swapnil-cometchat Feb 23, 2026
020e0e8
Update features-core.mdx
swapnil-cometchat Feb 23, 2026
a07ca7f
Update features-core.mdx
swapnil-cometchat Feb 23, 2026
59f35c7
Update extensions-overview.mdx
swapnil-cometchat Feb 23, 2026
57e41ec
Update bitly.mdx
swapnil-cometchat Feb 23, 2026
67bba36
Update docs.json
swapnil-cometchat Feb 23, 2026
664dc39
Update docs.json
swapnil-cometchat Feb 23, 2026
1ff2869
updates the format to mintlify
swapnil-cometchat Feb 23, 2026
4b687d1
update docs with mintlify format for extensions
swapnil-cometchat Feb 23, 2026
e683321
updates Smart Chat Features
swapnil-cometchat Feb 23, 2026
5c634eb
Update features-core.mdx
swapnil-cometchat Feb 23, 2026
0e832ef
Update link-preview.mdx
swapnil-cometchat Feb 23, 2026
7fff967
Update bitly.mdx
swapnil-cometchat Feb 23, 2026
fd1bb26
Update bitly.mdx
swapnil-cometchat Feb 23, 2026
4882e32
updates cards
swapnil-cometchat Feb 23, 2026
f2233d9
Update bitly.mdx
swapnil-cometchat Feb 23, 2026
650f9a4
updates the steps for extensions
swapnil-cometchat Feb 23, 2026
c22229d
update the steps for extentions
swapnil-cometchat Feb 23, 2026
00f026d
updates steps for extensions
swapnil-cometchat Feb 23, 2026
d05b610
Update features-core.mdx
swapnil-cometchat Feb 24, 2026
a45fb3d
Update bitly.mdx
swapnil-cometchat Feb 24, 2026
028552e
Update bitly.mdx
swapnil-cometchat Feb 24, 2026
56a2a2a
Update bitly.mdx
swapnil-cometchat Feb 24, 2026
f738e31
Update features-core.mdx
swapnil-cometchat Feb 24, 2026
93a6c56
Update link-preview.mdx
swapnil-cometchat Feb 24, 2026
df9f98b
updates #
swapnil-cometchat Feb 24, 2026
92cf3a4
---
swapnil-cometchat Feb 24, 2026
77617e9
Update pin-message.mdx
swapnil-cometchat Feb 24, 2026
53634a6
Update pin-message.mdx
swapnil-cometchat Feb 24, 2026
7f7fc22
Update rich-media-preview.mdx
swapnil-cometchat Feb 24, 2026
82574a9
Update save-message.mdx
swapnil-cometchat Feb 24, 2026
c8d5cec
Update thumbnail-generation.mdx
swapnil-cometchat Feb 24, 2026
f82408e
Update pin-message.mdx
swapnil-cometchat Feb 24, 2026
7ff46a1
Update rich-media-preview.mdx
swapnil-cometchat Feb 24, 2026
1803177
Update bitly.mdx
swapnil-cometchat Feb 24, 2026
93f403c
Update pin-message.mdx
swapnil-cometchat Feb 24, 2026
7a46ee3
Update link-preview.mdx
swapnil-cometchat Feb 24, 2026
affd133
Update features-core.mdx
swapnil-cometchat Feb 24, 2026
7091bd1
Update features-core.mdx
swapnil-cometchat Feb 24, 2026
658f14f
updates the code
swapnil-cometchat Feb 24, 2026
bec89a3
Update .gitignore
swapnil-cometchat Feb 24, 2026
d902feb
Update link-preview.mdx
swapnil-cometchat Feb 24, 2026
17d918a
Update features-core.mdx
swapnil-cometchat Feb 24, 2026
d6fdcd3
Update giphy.mdx
swapnil-cometchat Feb 24, 2026
c453369
updates the docs
swapnil-cometchat Feb 24, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.DS_Store

.kiro/
/cometchat-uikit-react-6
47 changes: 18 additions & 29 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -125,64 +125,53 @@
{
"group": "User Experience",
"pages": [
"fundamentals/bitly",
"fundamentals/link-preview",
"fundamentals/message-shortcuts",
"fundamentals/avatars",
"fundamentals/thumbnail-generation",
"fundamentals/link-preview",
"fundamentals/rich-media-preview",
"fundamentals/voice-transcription",
"fundamentals/pin-message",
"fundamentals/rich-media-preview",
"fundamentals/save-message",
"fundamentals/thumbnail-generation",
"fundamentals/tinyurl",
"fundamentals/bitly"
"fundamentals/voice-transcription"
]
},
"fundamentals/notification-extensions",
{
"group": "User Engagement",
"pages": [
"fundamentals/email-replies",
"fundamentals/smart-replies",
"fundamentals/giphy",
"fundamentals/message-translation",
"fundamentals/emojis",
"fundamentals/polls",
"fundamentals/reactions",
"fundamentals/stickers-stipop",
"fundamentals/reminders",
"fundamentals/stickers",
"fundamentals/video-broadcasting",
"fundamentals/mentions",
"fundamentals/giphy",
"fundamentals/tenor",
"fundamentals/gfycat",
"fundamentals/reminders"
"fundamentals/stickers-stipop",
"fundamentals/tenor"
]
},
"fundamentals/moderation-extensions",
{
"group": "Collaboration",
"pages": [
"fundamentals/collaborative-whiteboard",
"fundamentals/collaborative-document"
"fundamentals/collaborative-document",
"fundamentals/collaborative-whiteboard"
]
},
},
{
"group": "Customer Support",
"group": "Security",
"pages": [
"fundamentals/chatwoot",
"fundamentals/intercom"
"fundamentals/disappearing-messages"
]
},
{
"group": "Security",
"group": "Customer Support",
"pages": [
"fundamentals/disappearing-messages",
"fundamentals/end-to-end-encryption"
"fundamentals/chatwoot",
"fundamentals/intercom"
]
}
]
},
{
"group": "AI User Copilot",
"group": "Smart Chat Features",
"pages": [
"fundamentals/ai-user-copilot/overview",
"fundamentals/ai-user-copilot/conversation-starter",
Expand Down
32 changes: 19 additions & 13 deletions fundamentals/ai-user-copilot/conversation-starter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,33 @@ title: "Conversation Starter"

## Before you begin

1. Set up the AI settings through the CometChat dashboard as detailed in the [Overview section](/fundamentals/ai-user-copilot/overview).
2. Navigate to Chat > Features, under **AI User Copilot**, enable **Conversation Starter**.

<Frame>
<img src="/images/5e5dd82e-cometchat-ai-features-conversation-starter-3a48939de0ec4d575fb5c788552da0a2.png" />
</Frame>
3. Implement the chat functionality in your applications using [CometChat's **v4** Chat SDKs](/sdk/javascript/overview).
<Steps>
<Step title="Configure AI settings">
Set up AI in the CometChat dashboard as detailed in the [Overview](/fundamentals/ai-user-copilot/overview).
</Step>
<Step title="Enable Conversation Starter">
Go to **Chat** → **Features**, under **AI User Copilot**, enable **Conversation Starter**.
</Step>
<Step title="Use v4 Chat SDKs">
Implement chat using [CometChat v4 Chat SDKs](/sdk/javascript/overview).
</Step>
</Steps>

<Frame>
<img src="/images/5e5dd82e-cometchat-ai-features-conversation-starter-3a48939de0ec4d575fb5c788552da0a2.png" />
</Frame>

## How does it work?

CometChat AI analyzes the user's tone and writing style by reviewing recent messages sent by that user within the application.

The SDK includes a method for retrieving conversation starters in a chat. This method returns an array containing three potential starters for the conversation.

The number of messages to be fetched to generate relevant conversation starter is configurable. By default the CometChat AI takes the latest `1000` messages. This can be configured to specific timestamps as well.
The number of messages used to generate conversation starters is configurable. By default, CometChat AI uses the latest `1000` messages. You can also use timestamps.

| Configuration | Value |
| ------------- | ------------------------------------------------------ |
| lastNMessages | This will fetch specific number of messages. |
| fromTimestamp | This will fetch messages from a particular timestamp. |
| toTimestamp | This will fetch messages until a particular timestamp. |
- **lastNMessages**: Fetch a specific number of recent messages.
- **fromTimestamp**: Fetch messages from a particular timestamp.
- **toTimestamp**: Fetch messages up to a particular timestamp.

<Note>

Expand Down
34 changes: 20 additions & 14 deletions fundamentals/ai-user-copilot/conversation-summary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,34 @@ title: "Conversation Summary"

## Before you begin

1. Set up the AI settings through the CometChat dashboard as detailed in the [Overview section](/fundamentals/ai-user-copilot/overview).
2. Navigate to Chat > Features, under **AI User Copilot**, enable **Conversation Summary**.

<Frame>
<img src="/images/9b8957a8-cometchat-ai-features-conversation-summary-e03289a4865ac61bfa870fc60b5e40ef.png" />
</Frame>
3. Implement the chat functionality in your applications using [CometChat's **v4** Chat SDKs](/sdk/javascript/overview).
<Steps>
<Step title="Configure AI settings">
Set up AI in the CometChat dashboard as detailed in the [Overview](/fundamentals/ai-user-copilot/overview).
</Step>
<Step title="Enable Conversation Summary">
Go to **Chat** → **Features**, under **AI User Copilot**, enable **Conversation Summary**.
</Step>
<Step title="Use v4 Chat SDKs">
Implement chat using [CometChat v4 Chat SDKs](/sdk/javascript/overview).
</Step>
</Steps>

<Frame>
<img src="/images/9b8957a8-cometchat-ai-features-conversation-summary-e03289a4865ac61bfa870fc60b5e40ef.png" />
</Frame>

## How does it work?

CometChat AI goes through the messages of a conversation to understand the context of a conversation & provide a short summary of the conversation.

The CometChat SDK has a method to fetch the conversation summary. It returns the conversation summary as a string.

The number of messages to be fetched to generate relevant summaries is configurable. By default the CometChat AI takes the latest `1000` messages. This can be configured to specific timestamps as well.
The number of messages used to generate summaries is configurable. By default, CometChat AI uses the latest `1000` messages. You can also use timestamps.

| Configuration | Value |
| ------------- | ------------------------------------------------------ |
| lastNMessages | This will fetch specific number of messages. |
| fromTimestamp | This will fetch messages from a particular timestamp. |
| toTimestamp | This will fetch messages until a particular timestamp. |
| unreadOnly | This will fetch only the unread messages. |
- **lastNMessages**: Fetch a specific number of recent messages.
- **fromTimestamp**: Fetch messages from a particular timestamp.
- **toTimestamp**: Fetch messages up to a particular timestamp.
- **unreadOnly**: Fetch only unread messages.

<Note>

Expand Down
66 changes: 38 additions & 28 deletions fundamentals/ai-user-copilot/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,41 +1,51 @@
---
title: "AI User Copilot"
title: "Smart Chat Features"
sidebarTitle: "Overview"
---

## AI-Enabled Messaging Experience
CometChat AI helps conversations start faster, stay on track, and wrap up clearly with smart suggestions and summaries.

Picture a chat that effortlessly starts and flows, like catching up with your best buddy over a cup of coffee. With CometChat AI, we're making that a reality! Introducing **Conversation Starter** and **Smart Replies** that ignite natural and organic conversations. Say goodbye to awkward silences and hello to chat-filled adventures!
## Features

For those who require a concise overview of their discussions, the **Conversation Summary** feature is available to provide a succinct recap.
- **[Conversation Starter](/fundamentals/ai-user-copilot/conversation-starter)**: Suggests the first message to kick off a conversation.
- **[Smart Replies](/fundamentals/ai-user-copilot/smart-replies)**: Provides quick, context-aware replies.
- **[Conversation Summary](/fundamentals/ai-user-copilot/conversation-summary)**: Generates a concise summary of a conversation.

## Pre-requisite
## Prerequisites

* Login to your [CometChat dashboard](https://app.cometchat.com/login) and choose your app.
* Navigate to **AI Chatbot** > **Settings** in the left-hand menu.
<Steps>
<Step title="Open your CometChat app">
Login to your [CometChat dashboard](https://app.cometchat.com/login) and choose your app.
</Step>
<Step title="Open AI settings">
Navigate to **AI Chatbot** → **Settings** in the left-hand menu.
</Step>
</Steps>

<Frame>
<img src="/images/c2472804-cometchat-dashboard-ai-overview-905624fdf2187e841bb7e13ac75b5946.png" />
</Frame>

### Set the GPT Model

Enter the name of the Open AI ChatGPT model that you intend to use.

### Save the Open AI Key

You can get the Open AI Key from your [Open AI Account](https://platform.openai.com/account/api-keys). This will be used by CometChat to interact with the Open AI APIs.

### Set a Custom Instruction

Custom Instruction is an information which gets added in each and every ChatGPT prompt made by the CometChat AI. Custom Instruction is app-level information you can add to describe your use-case & inform what kind of responses you need from the CometChat AI.

### Set the Temperature

The API is non-deterministic by default. This means that you might get a slightly different completion every time you call it, even if your prompt stays the same. Setting temperature to 0 will make the outputs mostly deterministic, but a small amount of variability will remain.

Lower values for temperature result in more consistent outputs, while higher values generate more diverse and creative results. Select a temperature value based on the desired trade-off between coherence and creativity for your specific application.

### Enable AI

Toggle on AI.
## Configure AI

<Steps>
<Step title="Set the GPT model">
Enter the OpenAI ChatGPT model name you intend to use.
</Step>
<Step title="Save the OpenAI key">
Generate an API key from your [OpenAI account](https://platform.openai.com/account/api-keys) and save it here.
</Step>
<Step title="Set a custom instruction">
Add app-level context to guide how CometChat AI responds.
</Step>
<Step title="Set the temperature">
Choose a value based on the desired balance between consistency and creativity.
</Step>
<Step title="Enable AI">
Toggle AI on to activate these features.
</Step>
</Steps>

<Note>
Lower temperature values produce more consistent responses, while higher values are more creative.
</Note>
34 changes: 20 additions & 14 deletions fundamentals/ai-user-copilot/smart-replies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,34 @@ title: "Smart Replies"

## Before you begin

1. Configure the AI settings through the CometChat dashboard as detailed in the [Overview section](/fundamentals/ai-user-copilot/overview).
2. Navigate to Chat > Features, under **AI User Copilot**, enable **Smart Replies**.

<Frame>
<img src="/images/0500cc9d-cometchat-ai-features-smart-replies-9f1d86259a49e7ae41c175cad349442f.png" />
</Frame>
3. Implement the chat functionality in your applications using [CometChat's **v4** Chat SDKs](/sdk/javascript/overview).
<Steps>
<Step title="Configure AI settings">
Set up AI in the CometChat dashboard as detailed in the [Overview](/fundamentals/ai-user-copilot/overview).
</Step>
<Step title="Enable Smart Replies">
Go to **Chat** → **Features**, under **AI User Copilot**, enable **Smart Replies**.
</Step>
<Step title="Use v4 Chat SDKs">
Implement chat using [CometChat v4 Chat SDKs](/sdk/javascript/overview).
</Step>
</Steps>

<Frame>
<img src="/images/0500cc9d-cometchat-ai-features-smart-replies-9f1d86259a49e7ae41c175cad349442f.png" />
</Frame>

## How does it work?

CometChat AI goes through the messages of a conversation to understand the context of a conversation & provide relevant replies. It returns three replies: `positive, negative & neutral`.

The CometChat SDK has a method to fetch the smart replies in a conversation. It returns an object of three replies with keys: `positive, negative & neutral`.

The number of messages to be fetched to generate relevant Smart Replies is configurable. By default the CometChat AI takes the latest `1000` messages. This can be configured to specific timestamps as well.
The number of messages used to generate smart replies is configurable. By default, CometChat AI uses the latest `1000` messages. You can also use timestamps.

| Configuration | Value |
| ------------- | ------------------------------------------------------ |
| lastNMessages | This will fetch specific number of messages. |
| fromTimestamp | This will fetch messages from a particular timestamp. |
| toTimestamp | This will fetch messages until a particular timestamp. |
| unreadOnly | This will fetch only the unread messages. |
- **lastNMessages**: Fetch a specific number of recent messages.
- **fromTimestamp**: Fetch messages from a particular timestamp.
- **toTimestamp**: Fetch messages up to a particular timestamp.
- **unreadOnly**: Fetch only unread messages.

<Note>

Expand Down
14 changes: 11 additions & 3 deletions fundamentals/avatars.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,24 @@ With the Avatars Extension, your users can upload your end-users' avatar directl

## Extension settings

1. Login to [CometChat](https://app.cometchat.com/login) and select your app.
2. Go to the Extensions section and enable the Avatars extension.
<Steps>
<Step title="Open your CometChat app">
Login to [CometChat](https://app.cometchat.com/login) and select your app.
</Step>
<Step title="Enable Avatars">
Go to **Extensions** and enable the **Avatars** extension.
</Step>
</Steps>

## How does it work?

This extension allows the users to select an image for their avatar on CometChat.

Once the image file is selected for the avatar, it needs to be uploaded in the `base64` format. The extension hosts the image and updates its URL in the avatar section of the user's profile. Also, the avatar URL is sent back in the success response for being updated in your backend.

Image formats allowed by the extension are: `jpg`, `jpeg`, `png`, svg.
<Note>
Supported image formats: `jpg`, `jpeg`, `png`, `svg`.
</Note>

Make use of the `callExtension` method provided by the CometChat SDK as shown below.

Expand Down
Loading