@tagit/ai-client-core 0.2.0-beta.1 → 0.3.0-beta.1
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 +57 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# @tagit/ai-client-core
|
|
2
|
+
|
|
3
|
+
Headless TypeScript client core for the tagIt AI orchestrator.
|
|
4
|
+
|
|
5
|
+
## What This Package Does
|
|
6
|
+
|
|
7
|
+
- builds the orchestrator request payload
|
|
8
|
+
- manages chat state and history
|
|
9
|
+
- handles streaming, retries, and cancellation
|
|
10
|
+
- emits collector events when enabled
|
|
11
|
+
- exposes the core config and types used by the React package
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install @tagit/ai-client-core
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Quick Start
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
import { AIClient, createDefaultConfig } from '@tagit/ai-client-core';
|
|
23
|
+
|
|
24
|
+
const client = new AIClient(
|
|
25
|
+
createDefaultConfig('your-use-case-id', 'https://your-orchestrator.example.com', {
|
|
26
|
+
collector: {
|
|
27
|
+
enabled: false,
|
|
28
|
+
},
|
|
29
|
+
}),
|
|
30
|
+
);
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Configuration
|
|
34
|
+
|
|
35
|
+
The minimum runtime configuration is:
|
|
36
|
+
|
|
37
|
+
- `useCaseId` - the tagIt use case to execute
|
|
38
|
+
- `orchestrator.baseUrl` - the orchestrator base URL without `/v1/chat`; the client appends `/v1/chat` internally
|
|
39
|
+
|
|
40
|
+
Collector settings are optional unless you want telemetry:
|
|
41
|
+
|
|
42
|
+
- `collector.baseUrl`
|
|
43
|
+
- `collector.tagId`
|
|
44
|
+
- `collector.enabled`
|
|
45
|
+
|
|
46
|
+
## Related Package
|
|
47
|
+
|
|
48
|
+
If you want the full embeddable React widget, install:
|
|
49
|
+
|
|
50
|
+
- `@tagit/ai-client-react`
|
|
51
|
+
|
|
52
|
+
That package consumes this core client and exposes `AIClientProvider`, hooks, and the self-contained `ChatWidget`.
|
|
53
|
+
|
|
54
|
+
## Docs
|
|
55
|
+
|
|
56
|
+
- [React package integration guide](../ai-client-react/README.md)
|
|
57
|
+
- [Root README](../../README.md)
|