@doclessai/sdk 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +90 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# DoclessAI SDK
|
|
2
|
+
|
|
3
|
+
Plug-and-play AI assistants infrastructure as a service. Seamlessly integrate intelligent AI-powered chat assistants into your applications.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@doclessai/sdk)
|
|
6
|
+
[](LICENSE)
|
|
7
|
+
[](https://www.typescriptlang.org/)
|
|
8
|
+
|
|
9
|
+
**Homepage:** [doclessai.com](https://doclessai.vercel.app)
|
|
10
|
+
|
|
11
|
+
## 🚀 Features
|
|
12
|
+
|
|
13
|
+
- ✨ **Ready-to-use Chat Widget** - Drop-in React component for instant chat functionality
|
|
14
|
+
- 📄 **Media Upload Support** - Allow users to upload images for AI analysis
|
|
15
|
+
- 🎨 **Markdown Support** - Rich text responses with formatting
|
|
16
|
+
- 🔔 **Toast Notifications** - User-friendly feedback for errors and interactions
|
|
17
|
+
- 📱 **Responsive Design** - Works seamlessly on desktop and mobile
|
|
18
|
+
- 🎯 **Type-Safe** - Full TypeScript support with types included
|
|
19
|
+
- 🔧 **Flexible Client** - Use the DoclessClient directly for custom integrations
|
|
20
|
+
- 🌐 **Less Configuration** - Works out of the box with minimal setup
|
|
21
|
+
|
|
22
|
+
## 📦 Installation
|
|
23
|
+
|
|
24
|
+
Install the package using npm, yarn, or pnpm:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npm install @doclessai/sdk
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## 🎯 Quick Start
|
|
31
|
+
|
|
32
|
+
### Using the Chat Widget (React)
|
|
33
|
+
|
|
34
|
+
The easiest way to add AI chat to your application:
|
|
35
|
+
|
|
36
|
+
```tsx
|
|
37
|
+
import { ChatWidget } from '@doclessai/sdk';
|
|
38
|
+
|
|
39
|
+
export default function App() {
|
|
40
|
+
return (
|
|
41
|
+
<div>
|
|
42
|
+
<h1>My App</h1>
|
|
43
|
+
<ChatWidget appKey="your-app-key-here" />
|
|
44
|
+
</div>
|
|
45
|
+
);
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Using the DoclessClient
|
|
50
|
+
|
|
51
|
+
For more control, use the client directly:
|
|
52
|
+
|
|
53
|
+
```typescript
|
|
54
|
+
import { DoclessClient } from '@doclessai/sdk';
|
|
55
|
+
|
|
56
|
+
const client = new DoclessClient({
|
|
57
|
+
appKey: 'your-app-key-here'
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
// Ask a question
|
|
61
|
+
const response = await client.ask('user-query');
|
|
62
|
+
console.log(response.res);
|
|
63
|
+
|
|
64
|
+
// Ask with image attachment
|
|
65
|
+
const response = await client.ask('user-query',image);
|
|
66
|
+
console.log(response.res); // text response
|
|
67
|
+
console.log(response.image); // image url if returned
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## 🔗 Resources
|
|
72
|
+
|
|
73
|
+
- **Homepage:** [doclessai.com](https://doclessai.vercel.app)
|
|
74
|
+
- **GitHub:** [github.com/Dattatray8/doclessai-sdk](https://github.com/Dattatray8/doclessai-sdk)
|
|
75
|
+
- **NPM Package:** [@doclessai/sdk](https://www.npmjs.com/package/@doclessai/sdk)
|
|
76
|
+
|
|
77
|
+
## 👥 Author
|
|
78
|
+
|
|
79
|
+
**Dattatray** - [GitHub Profile](https://github.com/Dattatray8)
|
|
80
|
+
|
|
81
|
+
## 🙏 Support
|
|
82
|
+
|
|
83
|
+
If you encounter any issues or have questions, please:
|
|
84
|
+
1. Check the [documentation](https://doclessai.vercel.app/get-started)
|
|
85
|
+
2. Search existing [issues](https://github.com/Dattatray8/doclessai-sdk/issues)
|
|
86
|
+
3. Create a new issue with detailed information
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
Built with ❤️ by the DoclessAI team.
|