gci-ai-chat
v1.0.3
Published
A Vue 3 component for AI-powered chat functionality that can be installed via npm and used in any Vue project.
Readme
GciAIChat - Vue AI Chat Component
A Vue 3 component for AI-powered chat functionality that can be installed via npm and used in any Vue project.
Installation
npm install gci-ai-chat
# or
yarn add gci-ai-chatUsage
Basic Usage
<script setup lang="ts">
import { GciAIChat } from 'gci-ai-chat';
</script>
<template>
<div>
<GciAIChat />
</div>
</template>Custom Configuration
You can customize the API endpoint, client ID, and token:
<script setup lang="ts">
import { GciAIChat } from 'gci-ai-chat';
</script>
<template>
<div>
<GciAIChat
client-id="your-client-id"
endpoint="https://your-custom-api-endpoint.com/api/chat"
token="your-auth-token"
/>
</div>
</template>Required Parameters
The GciAIChat component requires the following parameters:
client-id: Your client identification stringendpoint: The API endpoint URL for the chat servicetoken: Authentication token for the API
<script setup lang="ts">
import { GciAIChat } from 'gci-ai-chat';
</script>
<template>
<div>
<GciAIChat
client-id="required-client-id"
endpoint="https://api.example.com/chat"
token="required-auth-token"
/>
</div>
</template>Development
Project Setup
npm installCompile and Hot-Reload for Development
npm run devBuild for Production
npm run buildFeatures
- Easy integration with Vue 3 projects
- Customizable AI chat functionality
- TypeScript support
- Lightweight and performant
Configuration
The component uses the following dependencies:
- Vue 3
- @ai-sdk/vue
- ai (for AI transport)
License
MIT
