Skip to content

Commit e683321

Browse files
swapnil-cometchatswapnil-cometchat
committed
updates Smart Chat Features
1 parent 4b687d1 commit e683321

4 files changed

Lines changed: 140 additions & 76 deletions

File tree

‎fundamentals/ai-user-copilot/conversation-starter.mdx‎

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,41 @@ title: "Conversation Starter"
66

77
## Before you begin
88

9-
1. Set up the AI settings through the CometChat dashboard as detailed in the [Overview section](/fundamentals/ai-user-copilot/overview).
10-
2. Navigate to Chat > Features, under **AI User Copilot**, enable **Conversation Starter**.
11-
12-
<Frame>
13-
<img src="/images/5e5dd82e-cometchat-ai-features-conversation-starter-3a48939de0ec4d575fb5c788552da0a2.png" />
14-
</Frame>
15-
3. Implement the chat functionality in your applications using [CometChat's **v4** Chat SDKs](/sdk/javascript/overview).
9+
<Steps>
10+
<Step title="Configure AI settings">
11+
Set up AI in the CometChat dashboard as detailed in the [Overview](/fundamentals/ai-user-copilot/overview).
12+
</Step>
13+
<Step title="Enable Conversation Starter">
14+
Go to **Chat** → **Features**, under **AI User Copilot**, enable **Conversation Starter**.
15+
</Step>
16+
<Step title="Use v4 Chat SDKs">
17+
Implement chat using [CometChat v4 Chat SDKs](/sdk/javascript/overview).
18+
</Step>
19+
</Steps>
20+
21+
<Frame>
22+
<img src="/images/5e5dd82e-cometchat-ai-features-conversation-starter-3a48939de0ec4d575fb5c788552da0a2.png" />
23+
</Frame>
1624

1725
## How does it work?
1826

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

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

23-
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.
24-
25-
| Configuration | Value |
26-
| ------------- | ------------------------------------------------------ |
27-
| lastNMessages | This will fetch specific number of messages. |
28-
| fromTimestamp | This will fetch messages from a particular timestamp. |
29-
| toTimestamp | This will fetch messages until a particular timestamp. |
31+
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.
32+
33+
<CardGroup cols={3}>
34+
<Card title="lastNMessages">
35+
Fetch a specific number of recent messages.
36+
</Card>
37+
<Card title="fromTimestamp">
38+
Fetch messages from a particular timestamp.
39+
</Card>
40+
<Card title="toTimestamp">
41+
Fetch messages up to a particular timestamp.
42+
</Card>
43+
</CardGroup>
3044

3145
<Note>
3246

‎fundamentals/ai-user-copilot/conversation-summary.mdx‎

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,44 @@ title: "Conversation Summary"
66

77
## Before you begin
88

9-
1. Set up the AI settings through the CometChat dashboard as detailed in the [Overview section](/fundamentals/ai-user-copilot/overview).
10-
2. Navigate to Chat > Features, under **AI User Copilot**, enable **Conversation Summary**.
11-
12-
<Frame>
13-
<img src="/images/9b8957a8-cometchat-ai-features-conversation-summary-e03289a4865ac61bfa870fc60b5e40ef.png" />
14-
</Frame>
15-
3. Implement the chat functionality in your applications using [CometChat's **v4** Chat SDKs](/sdk/javascript/overview).
9+
<Steps>
10+
<Step title="Configure AI settings">
11+
Set up AI in the CometChat dashboard as detailed in the [Overview](/fundamentals/ai-user-copilot/overview).
12+
</Step>
13+
<Step title="Enable Conversation Summary">
14+
Go to **Chat** → **Features**, under **AI User Copilot**, enable **Conversation Summary**.
15+
</Step>
16+
<Step title="Use v4 Chat SDKs">
17+
Implement chat using [CometChat v4 Chat SDKs](/sdk/javascript/overview).
18+
</Step>
19+
</Steps>
20+
21+
<Frame>
22+
<img src="/images/9b8957a8-cometchat-ai-features-conversation-summary-e03289a4865ac61bfa870fc60b5e40ef.png" />
23+
</Frame>
1624

1725
## How does it work?
1826

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

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

23-
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.
24-
25-
| Configuration | Value |
26-
| ------------- | ------------------------------------------------------ |
27-
| lastNMessages | This will fetch specific number of messages. |
28-
| fromTimestamp | This will fetch messages from a particular timestamp. |
29-
| toTimestamp | This will fetch messages until a particular timestamp. |
30-
| unreadOnly | This will fetch only the unread messages. |
31+
The number of messages used to generate summaries is configurable. By default, CometChat AI uses the latest `1000` messages. You can also use timestamps.
32+
33+
<CardGroup cols={2}>
34+
<Card title="lastNMessages">
35+
Fetch a specific number of recent messages.
36+
</Card>
37+
<Card title="fromTimestamp">
38+
Fetch messages from a particular timestamp.
39+
</Card>
40+
<Card title="toTimestamp">
41+
Fetch messages up to a particular timestamp.
42+
</Card>
43+
<Card title="unreadOnly">
44+
Fetch only unread messages.
45+
</Card>
46+
</CardGroup>
3147

3248
<Note>
3349

‎fundamentals/ai-user-copilot/overview.mdx‎

Lines changed: 50 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,59 @@
11
---
2-
title: "AI User Copilot"
2+
title: "Smart Chat Features"
33
sidebarTitle: "Overview"
44
---
55

6-
## AI-Enabled Messaging Experience
7-
8-
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!
9-
10-
For those who require a concise overview of their discussions, the **Conversation Summary** feature is available to provide a succinct recap.
11-
12-
## Pre-requisite
13-
14-
* Login to your [CometChat dashboard](https://app.cometchat.com/login) and choose your app.
15-
* Navigate to **AI Chatbot** > **Settings** in the left-hand menu.
6+
CometChat AI helps conversations start faster, stay on track, and wrap up clearly with smart suggestions and summaries.
7+
8+
## Features
9+
10+
<CardGroup cols={3}>
11+
<Card title="Conversation Starter" href="/fundamentals/ai-user-copilot/conversation-starter">
12+
Suggests the first message to kick off a conversation.
13+
</Card>
14+
<Card title="Smart Replies" href="/fundamentals/ai-user-copilot/smart-replies">
15+
Provides quick, context-aware replies.
16+
</Card>
17+
<Card title="Conversation Summary" href="/fundamentals/ai-user-copilot/conversation-summary">
18+
Generates a concise summary of a conversation.
19+
</Card>
20+
</CardGroup>
21+
22+
## Prerequisites
23+
24+
<Steps>
25+
<Step title="Open your CometChat app">
26+
Login to your [CometChat dashboard](https://app.cometchat.com/login) and choose your app.
27+
</Step>
28+
<Step title="Open AI settings">
29+
Navigate to **AI Chatbot** → **Settings** in the left-hand menu.
30+
</Step>
31+
</Steps>
1632

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

21-
### Set the GPT Model
22-
23-
Enter the name of the Open AI ChatGPT model that you intend to use.
24-
25-
### Save the Open AI Key
26-
27-
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.
28-
29-
### Set a Custom Instruction
30-
31-
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.
32-
33-
### Set the Temperature
34-
35-
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.
36-
37-
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.
38-
39-
### Enable AI
40-
41-
Toggle on AI.
37+
## Configure AI
38+
39+
<Steps>
40+
<Step title="Set the GPT model">
41+
Enter the OpenAI ChatGPT model name you intend to use.
42+
</Step>
43+
<Step title="Save the OpenAI key">
44+
Generate an API key from your [OpenAI account](https://platform.openai.com/account/api-keys) and save it here.
45+
</Step>
46+
<Step title="Set a custom instruction">
47+
Add app-level context to guide how CometChat AI responds.
48+
</Step>
49+
<Step title="Set the temperature">
50+
Choose a value based on the desired balance between consistency and creativity.
51+
</Step>
52+
<Step title="Enable AI">
53+
Toggle AI on to activate these features.
54+
</Step>
55+
</Steps>
56+
57+
<Note>
58+
Lower temperature values produce more consistent responses, while higher values are more creative.
59+
</Note>

‎fundamentals/ai-user-copilot/smart-replies.mdx‎

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,44 @@ title: "Smart Replies"
66

77
## Before you begin
88

9-
1. Configure the AI settings through the CometChat dashboard as detailed in the [Overview section](/fundamentals/ai-user-copilot/overview).
10-
2. Navigate to Chat > Features, under **AI User Copilot**, enable **Smart Replies**.
11-
12-
<Frame>
13-
<img src="/images/0500cc9d-cometchat-ai-features-smart-replies-9f1d86259a49e7ae41c175cad349442f.png" />
14-
</Frame>
15-
3. Implement the chat functionality in your applications using [CometChat's **v4** Chat SDKs](/sdk/javascript/overview).
9+
<Steps>
10+
<Step title="Configure AI settings">
11+
Set up AI in the CometChat dashboard as detailed in the [Overview](/fundamentals/ai-user-copilot/overview).
12+
</Step>
13+
<Step title="Enable Smart Replies">
14+
Go to **Chat** → **Features**, under **AI User Copilot**, enable **Smart Replies**.
15+
</Step>
16+
<Step title="Use v4 Chat SDKs">
17+
Implement chat using [CometChat v4 Chat SDKs](/sdk/javascript/overview).
18+
</Step>
19+
</Steps>
20+
21+
<Frame>
22+
<img src="/images/0500cc9d-cometchat-ai-features-smart-replies-9f1d86259a49e7ae41c175cad349442f.png" />
23+
</Frame>
1624

1725
## How does it work?
1826

1927
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`.
2028

2129
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`.
2230

23-
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.
24-
25-
| Configuration | Value |
26-
| ------------- | ------------------------------------------------------ |
27-
| lastNMessages | This will fetch specific number of messages. |
28-
| fromTimestamp | This will fetch messages from a particular timestamp. |
29-
| toTimestamp | This will fetch messages until a particular timestamp. |
30-
| unreadOnly | This will fetch only the unread messages. |
31+
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.
32+
33+
<CardGroup cols={2}>
34+
<Card title="lastNMessages">
35+
Fetch a specific number of recent messages.
36+
</Card>
37+
<Card title="fromTimestamp">
38+
Fetch messages from a particular timestamp.
39+
</Card>
40+
<Card title="toTimestamp">
41+
Fetch messages up to a particular timestamp.
42+
</Card>
43+
<Card title="unreadOnly">
44+
Fetch only unread messages.
45+
</Card>
46+
</CardGroup>
3147

3248
<Note>
3349

0 commit comments

Comments
 (0)