@eldrforge/ai-service 0.1.17 → 0.1.19
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/dist/index.js +7 -1
- package/dist/index.js.map +1 -1
- package/guide/index.md +72 -0
- package/package.json +4 -3
package/guide/index.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# @eldrforge/ai-service - Agentic Guide
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
AI-powered content generation for automation. Provides OpenAI integration with structured prompts, agentic executors, and comprehensive observability.
|
|
6
|
+
|
|
7
|
+
## Key Features
|
|
8
|
+
|
|
9
|
+
- **Agentic Executors** - Structured workflows for commit, publish, and release
|
|
10
|
+
- **Prompt Engineering** - Templated prompts with personas and instructions
|
|
11
|
+
- **Tool Integration** - Extensible tool registry for AI agents
|
|
12
|
+
- **Observability** - Conversation logging, metrics, and reflection
|
|
13
|
+
- **Interactive Mode** - Human-in-the-loop workflows
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { createAI, AgenticCommitExecutor } from '@eldrforge/ai-service';
|
|
19
|
+
|
|
20
|
+
// Initialize AI service
|
|
21
|
+
const ai = createAI({ apiKey: process.env.OPENAI_API_KEY });
|
|
22
|
+
|
|
23
|
+
// Use agentic executor
|
|
24
|
+
const executor = new AgenticCommitExecutor(ai, config);
|
|
25
|
+
await executor.execute();
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Dependencies
|
|
29
|
+
|
|
30
|
+
- @eldrforge/git-tools - Git operations
|
|
31
|
+
- openai - OpenAI API client
|
|
32
|
+
- @riotprompt/riotprompt - Prompt templating
|
|
33
|
+
|
|
34
|
+
## Package Structure
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
src/
|
|
38
|
+
├── agentic/ # Agentic executors
|
|
39
|
+
│ ├── commit.ts # Commit workflow
|
|
40
|
+
│ ├── publish.ts # Publish workflow
|
|
41
|
+
│ ├── release.ts # Release workflow
|
|
42
|
+
│ └── executor.ts # Base executor
|
|
43
|
+
├── prompts/ # Prompt templates
|
|
44
|
+
│ ├── commit.ts # Commit prompts
|
|
45
|
+
│ ├── release.ts # Release prompts
|
|
46
|
+
│ ├── review.ts # Review prompts
|
|
47
|
+
│ ├── instructions/ # System instructions
|
|
48
|
+
│ ├── personas/ # AI personas
|
|
49
|
+
│ └── templates.ts # Template utilities
|
|
50
|
+
├── tools/ # AI tool definitions
|
|
51
|
+
│ ├── commit-tools.ts
|
|
52
|
+
│ ├── publish-tools.ts
|
|
53
|
+
│ ├── release-tools.ts
|
|
54
|
+
│ └── registry.ts # Tool registry
|
|
55
|
+
├── observability/ # Observability utilities
|
|
56
|
+
│ ├── conversation-logger.ts
|
|
57
|
+
│ ├── metrics.ts
|
|
58
|
+
│ └── reflection.ts
|
|
59
|
+
├── ai.ts # Core AI client
|
|
60
|
+
├── interactive.ts # Interactive mode
|
|
61
|
+
└── index.ts
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Key Exports
|
|
65
|
+
|
|
66
|
+
- `createAI()` - Create AI client
|
|
67
|
+
- `AgenticCommitExecutor` - Commit workflow
|
|
68
|
+
- `AgenticPublishExecutor` - Publish workflow
|
|
69
|
+
- `AgenticReleaseExecutor` - Release workflow
|
|
70
|
+
- `createPrompt()` - Prompt templating
|
|
71
|
+
- `ToolRegistry` - Tool management
|
|
72
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@eldrforge/ai-service",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.19",
|
|
4
4
|
"description": "AI-powered content generation for automation - OpenAI integration with structured prompts",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"type": "module",
|
|
@@ -12,7 +12,8 @@
|
|
|
12
12
|
},
|
|
13
13
|
"files": [
|
|
14
14
|
"dist",
|
|
15
|
-
"examples"
|
|
15
|
+
"examples",
|
|
16
|
+
"guide"
|
|
16
17
|
],
|
|
17
18
|
"repository": {
|
|
18
19
|
"type": "git",
|
|
@@ -43,7 +44,7 @@
|
|
|
43
44
|
"author": "Tim O'Brien <tobrien@discursive.com>",
|
|
44
45
|
"license": "Apache-2.0",
|
|
45
46
|
"dependencies": {
|
|
46
|
-
"@eldrforge/git-tools": "^0.1.
|
|
47
|
+
"@eldrforge/git-tools": "^0.1.18",
|
|
47
48
|
"@riotprompt/riotprompt": "^0.0.10",
|
|
48
49
|
"openai": "^6.3.0"
|
|
49
50
|
},
|