You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<ahref="https://www.boldare.com/services/ai-software-development-consulting/"target="_blank">How we can help you</a>
13
-
</p>
6
+
A NestJS library for building efficient, scalable, and fast solutions using the OpenAI Assistant API (chatbots). <br> Kickstart your AI Assistant development in under 15 minutes 🚀
<ahref="https://www.boldare.com/services/ai-software-development-consulting/"target="_blank"><imgalt="docs"src="https://img.shields.io/badge/How we can help you-💡-brown"></a>
`@boldare/openai-assistant` - library to kickstart your AI Assistant development under 15 minutes.
16
+
</div>
17
+
18
+
# AI Assistant
18
19
19
20
Introducing the NestJS library. Whether you're building a virtual assistant, or an interactive chatbot for engaging user experiences, our library empowers you to leverage cutting-edge AI capabilities with minimal effort.
20
21
21
22
**The library provides ready-to-use API endpoints** handling your assistant and WebSocket server for real-time communication between the client and the assistant. Install the library and paste the config to get it running.
22
23
23
24
## 📚 Watch the tutorial
24
25
26
+
<divalign="center"style="text-align: center;">
27
+
25
28
[](https://www.youtube.com/watch?v=rxPdFat90qY)
26
29
30
+
[Video - AI Assistant in 15 min](https://www.youtube.com/watch?v=rxPdFat90qY)
31
+
32
+
</div>
33
+
27
34
## 🚀 Features
28
35
29
36
### AI Assistant library features
@@ -47,9 +54,9 @@ The repository contains a library but also provides additional features. You can
47
54
48
55
In this section, you will learn how to integrate the AI Assistant library into your NestJS application. The following steps will guide you through the process of setting up the library and creating simple functionalities.
49
56
50
-
<!-- The information that after this steps we will have the endpoints ready -->
Set up your environment variables, create environment variables in the `.env` file in the root directory of the project, and populate it with the necessary secrets. The assistant ID is optional and serves as a unique identifier for your assistant. When the environment variable is not set, the assistant will be created automatically. You can use the assistant ID to connect to an existing assistant, which can be found in the OpenAI platform after creating an assistant.
82
93
@@ -100,7 +111,9 @@ Please note that the `.env` file should not be committed to the repository. *Add
100
111
101
112
This was the first step needed to run the library. The next step is to configure the assistant.
The library provides a way to configure the assistant with the `AssistantModule.forRoot` method. The method takes a configuration object as an argument. Create a new configuration file like in a [sample configuration file (chat.config.ts)](apps%2Fapi%2Fsrc%2Fapp%2Fchat%2Fchat.config.ts) and fill it with the necessary configuration.
106
119
@@ -139,7 +152,10 @@ More details about the configuration can be found in the [wiki](https://github.c
139
152
From now you can run your application and call the assistant.
140
153
141
154
142
-
### Step 4: Function calling
155
+
</details>
156
+
<details>
157
+
<summary><b>Step 4:</b> Function calling</summary><br>
158
+
143
159
144
160
Function calling allows you to extend the assistant's capabilities with custom logic. **If you are not going to use function calling you can jump to: [Step 5: Testing](#step-5-running-the-application-and-testing).**
145
161
@@ -157,7 +173,9 @@ The instructions for creating a function can be found in the [wiki](https://gith
157
173
If you've defined a function and the output method, you can now call it from the assistant just by asking him to do the action described in the function definition.
158
174
159
175
160
-
### Step 5: Running the application and testing
176
+
</details>
177
+
<details>
178
+
<summary><b>Step 5:</b> Running the application and testing</summary><br>
161
179
162
180
Run your application and this will allow you to test the assistant.
163
181
@@ -184,24 +202,18 @@ Run your application and this will allow you to test the assistant.
184
202
185
203
Congrats! You have successfully integrated the AI Assistant library into your NestJS application. 🎉
186
204
187
-
---
188
-
205
+
</details>
189
206
190
207
## 🤔 Are you stuck?
191
208
192
-
Boldare's engineers are here to help you. If you have any questions or need help with the implementation, feel free to **[click here to book a call with one of our engineers.](https://calendly.com/olivier-halupczok/30min)**
193
-
194
-
**Learn more how [Boldare can help you with AI development on our website](https://www.boldare.com/services/ai-software-development-consulting/).**
195
-
196
-
You can also ask questions in the [GitHub Discussions](https://github.com/boldare/openai-assistant/discussions) section.
209
+
The complete documentation on how to run the demo with all applications and libraries from the repository can be found in the [wiki](https://github.com/boldare/openai-assistant/wiki/%F0%9F%91%A8%E2%80%8D%F0%9F%92%BB-Repository).
197
210
198
-
---
211
+
Boldare's engineers are here to help you. If you have any questions or need help with the implementation, feel free to [book a call](https://calendly.com/olivier-halupczok/30min) with one of our engineers.
199
212
200
-
## 👨💻 Repository
213
+
Learn more how **[Boldare can help you with AI development](https://www.boldare.com/services/ai-software-development-consulting/)**.
201
214
202
-
The complete documentation on how to run the demo with all applications and libraries from the repository can be found in the [wiki](https://github.com/boldare/openai-assistant/wiki/%F0%9F%91%A8%E2%80%8D%F0%9F%92%BB-Repository).
215
+
You can also ask questions in the [GitHub Discussions](https://github.com/boldare/openai-assistant/discussions) section.
203
216
204
-
---
205
217
206
218
## Contributions
207
219
@@ -210,8 +222,6 @@ Would you like to see new features in the library?
210
222
-[Talk your idea over with one of our engineers.](https://calendly.com/olivier-halupczok/30min)
211
223
- You can also [post your idea here](https://github.com/boldare/openai-assistant/discussions).
212
224
213
-
---
214
-
215
225
## License
216
226
217
227
`@boldare/openai-assistant` and this repository is MIT licensed
0 commit comments