Skip to content

Commit 0ce1d77

Browse files
committed
docs: update readme
1 parent 296904a commit 0ce1d77

File tree

2 files changed

+76
-12
lines changed

2 files changed

+76
-12
lines changed

README.md

Lines changed: 73 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,23 @@
1616
SwiftChat is a fast and responsive AI chat application developed with [React Native](https://reactnative.dev/) and
1717
powered by [Amazon Bedrock](https://aws.amazon.com/bedrock/), with compatibility extending to other model providers such
1818
as Ollama, DeepSeek, OpenAI and OpenAI Compatible. With its minimalist design philosophy and robust privacy protection,
19-
it delivers real-time streaming conversations and AI image generation capabilities across Android, iOS, and macOS
20-
platforms.
19+
it delivers real-time streaming conversations, AI image generation and voice conversation assistant capabilities
20+
across Android, iOS, and macOS platforms.
2121

2222
![](assets/promo.avif)
2323

2424
### What's New 🔥
2525

26+
- 🚀 Support Speech to Speech By Amazon Nova Sonic on Apple Platform. Check [How to Use](#amazon-nova-sonic) for
27+
more details. (From v2.3.0).
28+
- Support Request Latency and token response speed display (From v2.3.0).
29+
- Change to new bubble format UI for user question (From v2.3.0).
2630
- Support for OpenAI Compatible models. You can now
2731
use [easy-model-deployer](https://github.com/aws-samples/easy-model-deployer),
2832
OpenRouter, or any OpenAI-compatible model provider via SwiftChat. Please
2933
check [Configure OpenAI Compatible](#openai-compatible) section for more details(From v2.2.0).
30-
- Support for quick model switching (From v2.2.0).
31-
- Support regeneration of AI responses (From v2.2.0).
3234

33-
**Key Features:**
35+
### Key Features
3436

3537
- Real-time streaming chat with AI
3638
- Rich Markdown Support: Tables, Code Blocks, LaTeX and More
@@ -45,7 +47,43 @@ platforms.
4547
and [OpenAI Compatible](#openai-compatible) Models)
4648
- Fully Customizable System Prompt Assistant
4749

48-
**Supported Features For Amazon Nova series**
50+
### Amazon Nova Series Features
51+
52+
#### Amazon Nova Sonic Speech to Speech Model
53+
54+
**Usage Guide**
55+
56+
1. Amazon Nova Sonic model is supported starting from v2.3.0. If you have deployed it before, You Need to:
57+
* [Update CloudFormation](#upgrade-cloudformation) Stack
58+
* [Update API](#upgrade-api)
59+
* [Upgrade your App](#-quick-download) to v2.3.0 or later
60+
61+
If you have not Deployed your CloudFormation Stack please
62+
finish [Getting Started with Amazon Bedrock](#getting-started-with-amazon-bedrock) section.
63+
2. Switch the **Region** to `us-east-1` in the settings page and select the `Nova Sonic` under **Chat Model**.
64+
3. Return to Chat page, select a system prompt or directly click the microphone icon to start your conversation.
65+
66+
**Features for Speech to Speech**
67+
68+
1. Built-in spoken language practice for words and sentences, as well as storytelling scenarios. You can also add
69+
**Custom System Prompts** for voice chatting in different scenarios.
70+
2. Support **Barge In** by default, Also you can disable in system prompt.
71+
3. Support **Echo Cancellation**, You can talk directly to the device without wearing headphones.
72+
4. Support **Voice Waveform** to display volume level.
73+
74+
**General Talk**
75+
76+
https://github.com/user-attachments/assets/d3028312-c420-476c-88c2-ba870015f3c4
77+
78+
**Learn Sentences**
79+
80+
https://github.com/user-attachments/assets/ebf21b12-9c93-4d2e-a109-1d6484019838
81+
82+
**Telling Story on Mac**
83+
84+
https://github.com/user-attachments/assets/c70fc2b4-8960-4a5e-b4f8-420fcd5eafd4
85+
86+
#### Other Features
4987

5088
- Record 30-second videos directly on Android and iOS for Nova analysis
5189
- Upload large videos (1080p/4K) beyond 8MB with auto compression
@@ -57,7 +95,7 @@ platforms.
5795
#### YouTube Video
5896

5997
[<img src="./assets/youtube.avif">](https://www.youtube.com/watch?v=rey05WzfEbM)
60-
> The content in the video is an early version. For UI, architecture, and inconsistencies, please refer to the current
98+
> The content in the video is an early version. For UI, architecture, and inconsistencies, please refer to the current
6199
> documentation.
62100
63101
**Comprehensive Multimodal Analysis**: Text, Image, Document and Video
@@ -111,7 +149,7 @@ this [example](https://github.com/awslabs/aws-lambda-web-adapter/tree/main/examp
111149
Ensure you have access to Amazon Bedrock foundation models. SwiftChat default settings are:
112150

113151
- Region: `us-west-2`
114-
- Text Model: `Amazon Nova Pro`
152+
- Chat Model: `Amazon Nova Pro`
115153
- Image Model: `Stable Diffusion 3.5 Large`
116154

117155
If you are using the image generation feature, please make sure you have enabled access to the `Amazon Nova Lite` model.
@@ -195,7 +233,7 @@ Congratulations 🎉 Your SwiftChat App is ready to use!
195233
```bash
196234
http://localhost:11434
197235
```
198-
3. Once the correct Server URL is entered, you can select your desired Ollama models from the **Text Model** dropdown
236+
3. Once the correct Server URL is entered, you can select your desired Ollama models from the **Chat Model** dropdown
199237
list.
200238

201239
</details>
@@ -207,7 +245,7 @@ Congratulations 🎉 Your SwiftChat App is ready to use!
207245

208246
1. Go to the **Settings Page** and select the **DeepSeek** tab.
209247
2. Input your DeepSeek API Key.
210-
3. Choose DeepSeek models from the **Text Model** dropdown list. Currently, the following DeepSeek models are supported:
248+
3. Choose DeepSeek models from the **Chat Model** dropdown list. Currently, the following DeepSeek models are supported:
211249
- `DeepSeek-V3`
212250
- `DeepSeek-R1`
213251

@@ -220,9 +258,12 @@ Congratulations 🎉 Your SwiftChat App is ready to use!
220258

221259
1. Navigate to the **Settings Page** and select the **OpenAI** tab.
222260
2. Enter your OpenAI API Key.
223-
3. Select OpenAI models from the **Text Model** dropdown list. The following OpenAI models are currently supported:
261+
3. Select OpenAI models from the **Chat Model** dropdown list. The following OpenAI models are currently supported:
224262
- `GPT-4o`
225263
- `GPT-4o mini`
264+
- `GPT-4.1`
265+
- `GPT-4.1 mini`
266+
- `GPT-4.1 nano`
226267

227268
Additionally, if you have deployed the [ClickStream Server](#step-2-deploy-stack-and-get-your-api-url), you can enable
228269
the **Use Proxy** option to forward your requests.
@@ -239,7 +280,7 @@ the **Use Proxy** option to forward your requests.
239280
- `Base URL` of your model provider
240281
- `API Key` of your model provider
241282
- `Model ID` of the models you want to use (separate multiple models with commas)
242-
3. Select one of your models from the **Text Model** dropdown list.
283+
3. Select one of your models from the **Chat Model** dropdown list.
243284

244285
</details>
245286

@@ -379,6 +420,26 @@ the [release notes](https://github.com/aws-samples/swift-chat/releases) to see i
379420
- **For Lambda**: Click and open [Lambda Services](https://console.aws.amazon.com/lambda/home#/functions), find and open
380421
your Lambda which start with `SwiftChatLambda-xxx`, click the **Deploy new image** button and click Save.
381422

423+
### Upgrade CloudFormation
424+
425+
1. Click and open [CloudFormation](https://console.aws.amazon.com/cloudformation), switch to the region which you
426+
have deployed the **SwiftChatAPI** stack.
427+
2. Select the **SwiftChatAPI** Stack, click **Update stack** -> **Make a direct update**
428+
3. On the **Update stack** Page, select **Replace existing template** under the **Amazon S3 URL**, then input the
429+
following template url.
430+
431+
For App Runner
432+
```
433+
https://aws-gcr-solutions.s3.amazonaws.com/swift-chat/latest/SwiftChatAppRunner.template
434+
```
435+
For Lambda
436+
```
437+
https://aws-gcr-solutions.s3.amazonaws.com/swift-chat/latest/SwiftChatLambda.template
438+
```
439+
4. Click the **Next** button and continue click **Next** button. On the **Configure stack options** page,
440+
check `I acknowledge that AWS CloudFormation might create IAM resources.` then click **Next** and *Submit* button to
441+
update your CloudFormation Template.
442+
382443
## Security
383444

384445
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

react-native/src/chat/ChatScreen.tsx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -649,6 +649,9 @@ function ChatScreen(): React.JSX.Element {
649649
messagesRef.current.length > 0 &&
650650
messagesRef.current[0].user._id === userId
651651
) {
652+
if (userId === 1) {
653+
text = ' ' + text;
654+
}
652655
setMessages(previousMessages => {
653656
const newMessages = [...previousMessages];
654657
if (!newMessages[0].text.includes(text)) {

0 commit comments

Comments
 (0)