gci-chatbot-ai 1.0.24 → 1.0.26
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 +84 -3
- package/dist/gci-chatbot-ai.js +1118 -1104
- package/dist/gci-chatbot-ai.umd.cjs +32 -32
- package/dist/style.css +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,69 @@
|
|
|
1
|
-
|
|
1
|
+
# ChatbotComponent - Vue AI Chat Component
|
|
2
|
+
|
|
3
|
+
A Vue 3 component for AI-powered chat functionality that can be installed via npm and used in any Vue project.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install gci-chatbot-ai
|
|
9
|
+
# or
|
|
10
|
+
yarn add gci-chatbot-ai
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
### Basic Usage
|
|
16
|
+
|
|
17
|
+
```vue
|
|
18
|
+
<script setup lang="ts">
|
|
19
|
+
import { ChatbotComponent } from 'gci-chatbot-ai';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
<template>
|
|
23
|
+
<div>
|
|
24
|
+
<ChatbotComponent />
|
|
25
|
+
</div>
|
|
26
|
+
</template>
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Custom Configuration
|
|
30
|
+
|
|
31
|
+
You can customize the API endpoint, client ID, and token:
|
|
32
|
+
|
|
33
|
+
```vue
|
|
34
|
+
<script setup lang="ts">
|
|
35
|
+
import { ChatbotComponent } from 'gci-chatbot-ai';
|
|
36
|
+
</script>
|
|
37
|
+
|
|
38
|
+
<template>
|
|
39
|
+
<div>
|
|
40
|
+
<ChatbotComponent client-id="your-client-id" token="your-auth-token" endpoint="https://your-custom-api-endpoint.com/chat" />
|
|
41
|
+
</div>
|
|
42
|
+
</template>
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Required Parameters
|
|
46
|
+
|
|
47
|
+
The `ChatbotComponent` component requires the following parameters:
|
|
48
|
+
- `client-id`: Your client identification string
|
|
49
|
+
- `endpoint`: The API endpoint URL for the chat service
|
|
50
|
+
- `token`: Authentication token for the API
|
|
51
|
+
|
|
52
|
+
```vue
|
|
53
|
+
<script setup lang="ts">
|
|
54
|
+
import { ChatbotComponent } from 'gci-chatbot-ai';
|
|
55
|
+
</script>
|
|
56
|
+
|
|
57
|
+
<template>
|
|
58
|
+
<div>
|
|
59
|
+
<ChatbotComponent client-id="required-client-id" token="required-auth-token" endpoint="https://api.example.com/chat" />
|
|
60
|
+
</div>
|
|
61
|
+
</template>
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Development
|
|
65
|
+
|
|
66
|
+
### Project Setup
|
|
2
67
|
|
|
3
68
|
```sh
|
|
4
69
|
npm install
|
|
@@ -10,10 +75,26 @@ npm install
|
|
|
10
75
|
npm run dev
|
|
11
76
|
```
|
|
12
77
|
|
|
13
|
-
###
|
|
78
|
+
### Build for Production
|
|
14
79
|
|
|
15
80
|
```sh
|
|
16
81
|
npm run build
|
|
17
82
|
```
|
|
18
83
|
|
|
19
|
-
|
|
84
|
+
## Features
|
|
85
|
+
|
|
86
|
+
- Easy integration with Vue 3 projects
|
|
87
|
+
- Customizable AI chat functionality
|
|
88
|
+
- TypeScript support
|
|
89
|
+
- Lightweight and performant
|
|
90
|
+
|
|
91
|
+
## Configuration
|
|
92
|
+
|
|
93
|
+
The component uses the following dependencies:
|
|
94
|
+
- Vue 3
|
|
95
|
+
- @ai-sdk/vue
|
|
96
|
+
- ai (for AI transport)
|
|
97
|
+
|
|
98
|
+
## License
|
|
99
|
+
|
|
100
|
+
MIT
|