@connekz/connekz-agent 0.16.0 → 1.1.0
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 +6 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Human-like AI agent for seamless integration into websites, apps, and automations. This npm package allows developers to embed the Connekz agent as a customer assistant, task runner, and more.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Introduction
|
|
8
8
|
|
|
9
9
|
Connekz Agent is part of the Connekz developer toolkit, enabling AI-driven interactions in your projects. It supports natural conversations, built-in tools for tasks like bookings and website navigation, and easy integration via npm.
|
|
10
10
|
|
|
@@ -21,7 +21,7 @@ Connekz Agent is part of the Connekz developer toolkit, enabling AI-driven inter
|
|
|
21
21
|
Install via npm:
|
|
22
22
|
|
|
23
23
|
```bash
|
|
24
|
-
npm install @connekz/
|
|
24
|
+
npm install @connekz/connekz-agent
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
## Usage
|
|
@@ -30,7 +30,7 @@ Import and initialize the agent in your Vue.js project (compatible with Vue 3).
|
|
|
30
30
|
## Initialization Example
|
|
31
31
|
|
|
32
32
|
```typescript
|
|
33
|
-
import init, { type ConnekzInstance, type ConnekzAgentStatus, type ConnekzToolCallPayload } from '@connekz/
|
|
33
|
+
import init, { type ConnekzInstance, type ConnekzAgentStatus, type ConnekzToolCallPayload } from '@connekz/connekz-agent';
|
|
34
34
|
|
|
35
35
|
const connekzInstance: ConnekzInstance = init({
|
|
36
36
|
clientId: 'your-client-id', // Required
|
|
@@ -143,7 +143,7 @@ connekzSocket.cleanup(); // Remove listeners
|
|
|
143
143
|
### Basic Voice Agent on a React website
|
|
144
144
|
```jsx
|
|
145
145
|
import React, { useEffect, useState } from 'react';
|
|
146
|
-
import init from '@connekz/
|
|
146
|
+
import init from '@connekz/connekz-agent';
|
|
147
147
|
|
|
148
148
|
function App() {
|
|
149
149
|
const [instance, setInstance] = useState(null);
|
|
@@ -213,7 +213,7 @@ export default App;
|
|
|
213
213
|
|
|
214
214
|
<script setup>
|
|
215
215
|
import { ref, onMounted } from 'vue';
|
|
216
|
-
import init from '@connekz/
|
|
216
|
+
import init from '@connekz/connekz-agent';
|
|
217
217
|
|
|
218
218
|
const instance = ref(null);
|
|
219
219
|
const isActive = ref(false);
|
|
@@ -249,7 +249,7 @@ const toggleAgent = () => {
|
|
|
249
249
|
### Plain JavaScript Example
|
|
250
250
|
```javascript
|
|
251
251
|
// Initialize in a script tag or main.js
|
|
252
|
-
import init from '@connekz/
|
|
252
|
+
import init from '@connekz/connekz-agent';
|
|
253
253
|
|
|
254
254
|
const connekzInstance = init({
|
|
255
255
|
clientId: 'your-client-id',
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@connekz/connekz-agent",
|
|
3
3
|
"private": false,
|
|
4
4
|
"type": "module",
|
|
5
|
-
"version": "
|
|
5
|
+
"version": "1.1.0",
|
|
6
6
|
"description": "A package for Connekz clients to integrate Connekz Agent into their applications.",
|
|
7
7
|
"main": "./dist/connekz-agent.umd.js",
|
|
8
8
|
"module": "./dist/connekz-agent.es.js",
|