ad-agent_architecture 0.0.2 → 0.0.4

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.
Files changed (9) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +6 -0
  4. data/docs/erd.svg +12 -0
  5. data/docs/requirements.md +86 -0
  6. data/lib/ad/agent_architecture/version.rb +1 -1
  7. data/package-lock.json +2 -2
  8. data/package.json +1 -1
  9. metadata +3 -1
data/docs/requirements.md ADDED
@@ -0,0 +1,86 @@
1
+
2
+ ## Schema for AI Agents
3
+
4
+ ### Entity Relationship Diagram
5
+
6
+ ![Schema](./erd.svg)
7
+
8
+ ### Static Workflow Definition
9
+
10
+ #### Table: workflows
11
+ | Field | Type | Description |
12
+ |-------------|--------|-------------------------------------|
13
+ | id | string | Unique identifier for the workflow |
14
+ | name | string | The name of the workflow |
15
+ | description | string | A brief description of the workflow |
16
+
17
+ #### Table: sections
18
+ | Field | Type | Description |
19
+ |-------------|---------|----------------------------------------|
20
+ | id | string | Unique identifier for the section |
21
+ | name | string | The name of the section |
22
+ | description | string | A brief description of the section |
23
+ | order | integer | The order of the section in the workflow|
24
+ | workflow_id | string | Foreign key referencing workflows |
25
+
26
+ #### Table: steps
27
+ | Field | Type | Description |
28
+ |-------------|---------|-------------------------------------|
29
+ | id | string | Unique identifier for the step |
30
+ | name | string | The name of the step |
31
+ | description | string | A brief description of the step |
32
+ | order | integer | The order of the step in the section|
33
+ | section_id | string | Foreign key referencing sections |
34
+ | prompt | string | The template string for the prompt |
35
+
36
+ #### Table: attributes
37
+ | Field | Type | Description |
38
+ |-------------|---------|---------------------------------------------|
39
+ | id | string | Unique identifier for the attribute |
40
+ | name | string | The name of the attribute |
41
+ | type | string | The type of the attribute (e.g., string) |
42
+ | is_array | boolean | Indicates whether the attribute is an array |
43
+ | workflow_id | string | Foreign key referencing workflows |
44
+
45
+ #### Table: input_attributes
46
+ | Field | Type | Description |
47
+ |-------------|---------|------------------------------------|
48
+ | step_id | string | Foreign key referencing steps |
49
+ | attribute_id| string | Foreign key referencing attributes |
50
+
51
+ #### Table: output_attributes
52
+ | Field | Type | Description |
53
+ |-------------|---------|------------------------------------|
54
+ | step_id | string | Foreign key referencing steps |
55
+ | attribute_id| string | Foreign key referencing attributes |
56
+
57
+ ### Dynamic Workflow Execution
58
+
59
+ #### Table: workflow_runs
60
+ | Field | Type | Description |
61
+ |-------------|--------|---------------------------------------|
62
+ | id | string | Unique identifier for the workflow run|
63
+ | workflow_id | string | Foreign key referencing workflows |
64
+
65
+ #### Table: section_runs
66
+ | Field | Type | Description |
67
+ |-----------------|--------|----------------------------------------|
68
+ | id | string | Unique identifier for the section run |
69
+ | workflow_run_id | string | Foreign key referencing workflow_runs |
70
+ | section_id | string | Foreign key referencing sections |
71
+
72
+ #### Table: step_runs
73
+ | Field | Type | Description |
74
+ |------------------|---------|---------------------------------------------------------------------|
75
+ | id | string | Unique identifier for the step run |
76
+ | section_run_id | string | Foreign key referencing section_runs |
77
+ | step_id | string | Foreign key referencing steps |
78
+ | branch_number | integer | Branch number to distinguish different instances (branches) of the same step |
79
+
80
+ #### Table: attribute_values
81
+ | Field | Type | Description |
82
+ |---------------|--------|-----------------------------------------|
83
+ | id | string | Unique identifier for the attribute value|
84
+ | attribute_id | string | Foreign key referencing attributes |
85
+ | step_run_id | string | Foreign key referencing step_runs |
86
+ | value | text | The actual value of the attribute during the step execution |
data/lib/ad/agent_architecture/version.rb CHANGED
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Ad
4
4
  module AgentArchitecture
5
- VERSION = '0.0.2'
5
+ VERSION = '0.0.4'
6
6
  end
7
7
  end
data/package-lock.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "ad-agent_architecture",
3
- "version": "0.0.2",
3
+ "version": "0.0.4",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "ad-agent_architecture",
9
- "version": "0.0.2",
9
+ "version": "0.0.4",
10
10
  "devDependencies": {
11
11
  "@klueless-js/semantic-release-rubygem": "github:klueless-js/semantic-release-rubygem",
12
12
  "@semantic-release/changelog": "^6.0.3",
data/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ad-agent_architecture",
3
- "version": "0.0.2",
3
+ "version": "0.0.4",
4
4
  "description": "Architecture/Schema for AI Agents",
5
5
  "scripts": {
6
6
  "release": "semantic-release"
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ad-agent_architecture
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.2
4
+ version: 0.0.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - David Cruwys
@@ -47,6 +47,8 @@ files:
47
47
  - Rakefile
48
48
  - bin/console
49
49
  - bin/setup
50
+ - docs/erd.svg
51
+ - docs/requirements.md
50
52
  - lib/ad/agent_architecture.rb
51
53
  - lib/ad/agent_architecture/version.rb
52
54
  - package-lock.json