klue-langcraft 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d602a256a1c785e201aa855cbd20a48dc8400c358589a8e9fa3d899c8ae1249f
-  data.tar.gz: 8c78bb231cc1b13f3a50d315036bf895123f365b1e11b22940324c803a179f70
+  metadata.gz: 6f512e176bfdc09449895ba8775adc469ef781527160585aa61a0c14b4436041
+  data.tar.gz: 1a36e20159e2d80413bd440abd42f70f5e033ac08ed14ad018b567b3c76e6ad0
 SHA512:
-  metadata.gz: de1535dabb901c06d46310dd2991ce5188b35690d5008ac9304a45493a335bbd4b482693048ac59ac23f0deaad87cfaf56c229edc5ffedf6c7e95899ce1192b5
-  data.tar.gz: 66d3bc952009ea2e761bab7a878dc80869e06bde74fdfef962e80ecec9a3aa0532a6a16370b4da366d5c23b05387a4366f44c57758c725648a812eacec5b15fd
+  metadata.gz: a1f4d04d74426eae5675a1d45df6a6de92a23e913c1ab75fedc8762e763f4b31435d3f7f30e36c9ef0511015b201f90fe1c5b2735a94f305cdcd80f5abbe8922
+  data.tar.gz: 2f102d4c6f195477cd524c9cf919637d8cbdaa5e7ac0cbfad7ed4b7cbf5d24e65793d36838e4414e5bded37278f03c9b56f7d3096fd3db6d9a6950802ae107dc

data/.builders/generators/project-plan.rb

@@ -8,6 +8,11 @@ KManager.action :project_plan do
         grid_layout(y: 190, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
 
         todo(title: 'DSLs as Code sample DSL')
+        todo(title: 'Automate Base DSL setup')
+        todo(title: 'Automate DSL definion/designer for target DSL')
+        # todo(title: '')
+        # todo(title: '')
+        # todo(title: '')
 
       end
       .page('To Do', theme: :style_02, margin_left: 0, margin_top: 0) do

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.0.7](https://github.com/appydave/klue-langcraft/compare/v0.0.6...v0.0.7) (2024-09-21)
+
+
+### Bug Fixes
+
+* update documentation for usecases ([077689e](https://github.com/appydave/klue-langcraft/commit/077689e085b667b3ac29dd2798b6b38e39a28923))
+
+## [0.0.6](https://github.com/appydave/klue-langcraft/compare/v0.0.5...v0.0.6) (2024-09-20)
+
+
+### Bug Fixes
+
+* update documentation for usecases ([298f85a](https://github.com/appydave/klue-langcraft/commit/298f85aabf2a8acfad4926f2127017174df03ce4))
+
 ## [0.0.5](https://github.com/appydave/klue-langcraft/compare/v0.0.4...v0.0.5) (2024-09-20)
 
 

data/README.md

@@ -50,8 +50,6 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 ```bash
 bin/console
 
-Aaa::Bbb::Program.execute()
-# => ""
 ```
 
 `klue-langcraft` is setup with Guard, run `guard`, this will watch development file changes and run tests automatically, if successful, it will then run rubocop for style quality.

data/docs/dsl-examples.md

@@ -0,0 +1,105 @@
+# DSL Examples
+
+The following examples will build on top of one another to create an Agent as Code DSL designed for Agent Workflows.
+
+The example workflow will ben implementation of the agent as code for YouTube Launch Optimization.
+
+### Root Node (#1).
+
+The root node for a DSL is named `definition`, it behaves like any other `node` accept that you provide the DSL name.
+
+An agentic workflow might take a name and optional description.
+
+```ruby
+# Sample DSL
+workflow :youtube_launch_optimizer, 'Optimize the video publishing for YouTube Titles, Descriptions, Thumbnails and social content' do
+end
+```
+
+```ruby
+# DSL Definition
+definition :workflow do
+  param :name, type: :positional
+  param :description, type: :positional, default: nil
+end
+```
+
+### Root Node (#2).
+
+An agentic workflow might take a name only and use a child node for description using a self closing syntax.
+
+```ruby
+# Sample DSL
+workflow :youtube_launch_optimizer do
+  description 'Optimize the video publishing for YouTube Titles, Descriptions, Thumbnails and social content'
+end
+```
+
+```ruby
+# DSL Definition
+definition :workflow do
+  param :name, type: :positional
+  node :description do
+    param :description, type: :positional
+  end
+end
+```
+
+### Single Node with List (#3)
+
+Here we have a single node called settings with a list of setting that contains a key and a value.
+Notice `repeat: true` is used to indicate that the setting is a repeatable element.
+
+```ruby
+# Sample DSL
+
+workflow :youtube_launch_optimizer do
+  settings do
+    setting :prompt_path, 'prompts/youtube/launch_optimizer'
+    setting :default_llm, :gpt4o
+  end
+end
+```
+
+```ruby
+# DSL Definition
+definition :workflow do
+  param :name, type: :positional
+  node :settings do
+    node :setting, repeat: true do
+      param :key, type: :positional
+      param :value, type: :positional
+    end
+  end
+end
+```
+
+### Single Node with list - declaritve syntax  (#4)
+
+Like before, we have a single node called settings with a list of setting that contains a key and a value.
+This time the you can use the method name as the first paramater value because it is of type declarative.
+This can make some DSL usage a little easier to understand
+
+```ruby
+# Sample DSL
+
+workflow :youtube_launch_optimizer do
+  settings do
+    prompt_path 'prompts/youtube/launch_optimizer'
+    default_llm :gpt4o
+  end
+end
+```
+
+```ruby
+# DSL Definition
+definition :workflow do
+  param :name, type: :positional
+  node :settings do
+    node :setting, repeat: true do
+      param :key, type: :declaritive      # the method name typed in will be come the value for the key paramater
+      param :value, type: :positional
+    end
+  end
+end
+```

data/docs/dsl-rules.md

@@ -0,0 +1,155 @@
+# DSL Rules
+
+The DSL using ruby like syntax that maps paramaters and values in fashion similar to the Ruby programming language.
+
+## Data Types in DSLs
+
+DSLs can use various types of data as input and provide flexibility in handling different kinds of values. Below are the main data types supported:
+
+- **Strings:** Represent textual data and are enclosed in quotes. They are typically used for descriptive content or text-based parameters.
+- **Symbols:** Identifiers often used for keys or labels in configuration. Symbols are concise and unique, making them ideal for representing options or identifiers.
+- **Booleans:** Represent true/false values and are useful for toggling features or conditions within the DSL.
+- **Integers:** Whole numbers without fractions, often used for quantities, counts, or IDs.
+- **Floats:** Numbers that include decimal points, used when more precise values are required, such as for time durations or percentages.
+
+These data types allow the DSL to handle a wide variety of input values, making it versatile for different use cases and configurations.
+
+Note: Data types are currently only cosmetic, everything will get stored as a string internally, but we might put in some validation that can at least let us know if we've got the wrong sort of data provided.
+
+
+## DSL argument rules
+
+In Ruby, parameters (or "arguments") come in various types such as positional, optional, splat (*), and keyword arguments (**). 
+Each parameter type follows specific conventions, and the Ruby language uses distinct terms for each. 
+Below is an overview of these types and their corresponding metadata fields.
+
+### Methods and Arguements
+
+#### 1. Positional Parameters
+- **Description**: These are the most common type of parameters. They are passed in the exact order defined in the method signature.
+- **Ruby Example**: `def method(a, b)`
+- **Metadata Fields**:
+  - `type`: positional
+  - `name`: a (or the parameter name)
+- **Inferred Fields**:
+  - `required`: true
+
+```ruby
+param :a, type: :positional               # required: true
+param :b, type: :positional               # required: true
+```
+
+#### 2. Optional Parameters
+- **Description**: These are positional parameters with default values, making them optional.
+- **Ruby Example**: `def method(a = 1)`
+- **Metadata Fields**:
+  - `type`: positional
+  - `name`: a
+  - `default_value`: 1
+- **Inferred Fields**:
+  - `required`: false
+
+```ruby
+param :a, type: :positional, default: 1   # required: false
+```
+
+#### 3. Splat Parameters (*)
+- **Description**: The splat operator `*` captures any number of additional positional arguments into an array.
+- **Ruby Example**: `def method(*args)`
+- **Metadata Fields**:
+  - `type`: splat
+  - `name`: args
+- **Inferred Fields**:
+  - `required`: false
+  - `variadic`: true
+
+```ruby
+param :args, type: :splat                 # required: false, variadic: true
+```
+
+#### 4. Keyword Parameters
+- **Description**: Keyword arguments are named arguments passed as a hash or individual key-value pairs. They can be required or optional.
+- **Ruby Example**: `def method(a:, b: 1)`
+- **For required keyword argument**:
+  - **Metadata Fields**:
+      - `type`: keyword
+      - `name`: a
+  - **Inferred Fields**:
+    - `required`: true
+- **For optional keyword argument**:
+  - **Metadata Fields**:
+    - `type`: keyword
+    - `name`: b
+    - `default_value`: 1
+  - **Inferred Fields**:
+    - `required`: false
+
+```ruby
+param :a, type: :keyword                  # required: true
+param :b, type: :keyword, default: 1      # required: true
+```
+
+
+#### 5. Double Splat Parameters (**)
+- **Description**: The double splat operator `**` captures any number of additional keyword arguments into a hash.
+- **Ruby Example**: `def method(**opts)`
+- **Metadata Fields**:
+  - `type`: double_splat
+  - `name`: opts
+- **Inferred Fields**:
+  - `required`: false
+  - `variadic`: true
+
+```ruby
+param :opts, type: :double_splat           # required: false, variadic: true
+```
+
+#### Block Paramaters
+
+The idea of ruby block parameters have been deprectated, instead the syntax has been retained for containers, see below.
+
+## DSL Containers
+
+Containers represent a named block that can take parameters and contain aditional nested elements.
+
+They follow usage that is similar in concept to an XML element, in that they have a name, then can take paramaters (aka attributes) and then can be self closing.
+
+The container will be represented as a `do ... end` when hosting child containers
+The container can also be self closing, in which case there is no `do ... end`, there is just an element with zero or more parameters followed by a newline.
+
+The root containers will be called `definition`, all other containers will be known as `node`
+
+### Rules
+
+These rules should be observed when dealing with different parameters and blocks
+
+**Required vs Optional Parameters:**
+
+- **Positional required parameters**: Defined without a default value.
+- **Optional positional parameters**: Have default values or are represented with splat (`*`).
+- **Required keyword arguments**: Must be passed explicitly unless a default value is provided.
+- **Optional keyword arguments**: Have default values or can be omitted.
+
+### Order and constraints
+
+A container can take parameters based on the defined styles, but they must follow an order and adhere to constraints.
+
+**Order/Construction:**
+
+1. Declarative parameters (if present, the method name acts as the first positional parameter)
+2. Required positional parameters
+3. Optional positional parameters
+4. Splat parameters, zero or one
+5. Required keyword parameters
+6. Optional keyword parameters
+7. Double splat parameters, zero or one
+
+**Constraints:**
+
+1. Declarative parameters, if present, replace the first positional parameter, and no additional required positional parameters can come before it.
+2. Required positional parameters must come before any optional positional parameters.
+3. The splat parameter, if present, must come after all positional parameters (required and optional).
+4. Keyword parameters (both required and optional) must come after all positional and splat parameters.
+5. The double splat parameter, if present, must be the last parameter.
+6. You can't have more than one splat or double splat parameter in a container.
+7. Once you start using keyword parameters, you can't use positional parameters anymore in that container.

data/docs/dsl-samples/index.md

@@ -0,0 +1,4 @@
+Printspeak DSL
+Project Plan
+Agent As Code
+Make Chapters out of my recordings using a folder and glob pattern geared to my naming convention

data/docs/dsl-samples/youtube-launch-optimizer-old.klue

@@ -0,0 +1,300 @@
+dsl = Agent.create(:youtube_launch_optimizer) do
+  description 'This workflow optimizes video launch by analyzing, preparing, and generating content for various platforms.'
+  settings do
+    prompt_path Ad::AgentArchitecture.gem_relative_file('prompts/youtube/launch_optimizer')
+    default_llm :gpt4o
+  end
+
+  prompts do
+    prompt :video_summary_prompt              , content: load_file('1-1-summarize-video.txt')
+    prompt :video_abridgement_prompt          , content: load_file('1-2-1-abridge-video.txt')
+    prompt :abridgement_descrepencies_prompt  , content: load_file('1-2-2-abridge-video-descrepencies.txt')
+    prompt :identify_chapters_prompt          , content: load_file('2-1-identify-chapters.txt')
+    prompt :refine_chapters_prompt            , content: load_file('2-2-refine-chapters.txt')
+    prompt :create_chapters_prompt            , content: load_file('2-3-create-chapters.txt')
+    prompt :analyze_content_essence_prompt    , content: load_file('3-1-analyze-content-essence.txt')
+    prompt :analyze_audience_engagement_prompt, content: load_file('3-2-analyze-audience-engagement.txt')
+    prompt :analyze_cta_competitors_prompt    , content: load_file('3-3-analyze-cta-competitors.txt')
+    prompt :title_generation_prompt           , content: load_file('4-1-generate-title.txt')
+    prompt :thumbnail_text_prompt             , content: load_file('4-2-generate-thumbnail-text.txt')
+    prompt :thumbnail_visual_elements_prompt  , content: load_file('4-3-thumbnail-visual-elements.txt')
+    prompt :yt_simple_description_prompt      , content: load_file('5-1-yt-simple-description.txt')
+    prompt :yt_description_prompt             , content: load_file('5-2-yt-write-description.txt')
+    prompt :yt_format_description_prompt      , content: load_file('5-3-yt-format-description.txt')
+    prompt :yt_description_custom_gpt_prompt  , content: load_file('5-4-yt-description-custom-gpt.txt')
+    prompt :yt_pinned_comment_prompt          , content: load_file('5-5-yt-pinned-comment.txt')
+    prompt :yt_metadata_prompt                , content: load_file('5-6-yt-meta-data.txt')
+    prompt :tweet_prompt                      , content: load_file('6-1-create-tweet.txt')
+    prompt :facebook_post_prompt              , content: load_file('6-2-create-fb-post.txt')
+    prompt :linkedin_post_prompt              , content: load_file('6-3-create-linkedin-post.txt')
+  end
+
+  attributes do
+    attribute :short_title, type: :string
+    attribute :transcript, type: :string
+    attribute :srt, type: :string
+    attribute :summary, type: :string
+    attribute :abridgement, type: :string
+    attribute :abridgement_descrepencies, type: :string
+    attribute :analyze_content_essence, type: :string
+    attribute :analyze_audience_engagement, type: :string
+    attribute :analyze_cta_competitors, type: :string
+    attribute :video_title, type: :string
+    attribute :video_url, type: :string
+    attribute :video_topic_theme, type: :string
+    attribute :video_related_links, type: :array
+    attribute :video_keywords, type: :array
+    attribute :video_description, type: :string
+    attribute :video_description_custom_gpt, type: :string
+    attribute :video_pinned_comment, type: :string
+    attribute :video_metadata, type: :string
+    attribute :content_highlights
+    attribute :identify_chapters, type: :string
+    attribute :refine_chapters, type: :string
+    attribute :chapters, type: :string
+    attribute :fold_cta, type: :string
+    attribute :primary_cta, type: :string
+    attribute :affiliate_cta, type: :array
+    attribute :brand_info, type: :string
+    attribute :title_ideas, type: :array
+    attribute :thumbnail_text, type: :string
+    attribute :thumbnail_visual_elements, type: :string
+    attribute :tweet_content, type: :string
+    attribute :facebook_post, type: :string
+    attribute :linkedin_post, type: :string
+  end
+
+  # Clean SRT
+  # Intro/Outro/Content Seperation
+  # Chapter Name Suggeestions
+  # B-Roll Suggestions
+  # section('Transcript Analysis') do
+  #   step('')
+  # end
+
+  section('Video Preparation') do
+    step('Configure') do
+      input :brand_info
+      input :short_title
+      input :video_title
+      input :video_url
+      input :video_related_links
+      input :video_keywords
+      input :fold_cta
+      input :primary_cta
+      input :affiliate_cta
+      input :chapters
+      input :transcript
+      input :abridgement
+      input :summary
+    end
+
+    step('Script Summary') do
+      input :transcript
+      prompt :video_summary_prompt
+      output :summary
+    end
+
+    step('Script Abridgement') do
+      input :transcript
+      prompt :video_abridgement_prompt
+      output :abridgement
+    end
+
+    step('Abridge QA') do
+      input :transcript
+      input :abridgement
+      prompt :abridgement_descrepencies_prompt
+      output :abridgement_descrepencies
+    end
+  end
+
+  section('Build Chapters') do
+    step('Find Chapters') do
+      input :transcript
+      input :abridgement
+      prompt :identify_chapters_prompt
+      output :identify_chapters
+    end
+
+    step('Refine Chapters') do
+      input :identify_chapters
+      input :refine_chapters
+      prompt :refine_chapters_prompt
+      output :chapters
+    end
+
+    step('Create Chapters') do
+      input :chapters
+      input :srt
+      prompt :create_chapters_prompt
+      output :chapters
+    end
+  end
+
+  section('Content Analysis') do
+    step('Content Essence') do
+      input :abridgement
+      prompt :analyze_content_essence_prompt
+      output :analyze_content_essence
+    end
+
+    step('Audience Engagement') do
+      input :abridgement
+      prompt :analyze_audience_engagement_prompt
+      output :analyze_audience_engagement
+    end
+
+    step('CTA/Competitors') do
+      input :abridgement
+      prompt :analyze_cta_competitors_prompt
+      output :analyze_cta_competitors
+    end
+
+    # step('Analyze Video') do
+    #   input :transcript
+    #   prompt :analyze_content_essence_prompt
+    #   output :video_topic
+    #   output :video_keywords
+    # end
+  end
+
+  section('Title & Thumbnail') do
+    step('Title Ideas') do
+      input :short_title              #
+      input :video_topic_theme        # (Main Topic or Theme)
+      input :content_highlights       # (Keywords/Insites/Takeaways/Audience-Related Insights)
+      prompt :title_generation_prompt
+      output :title_ideas
+    end
+
+    # Analyze Title Short List
+    # Here are the types of prompts or questions you've been writing:
+
+    # Title Analysis: Requesting evaluations of YouTube titles.
+    # Title Suggestions: Asking for new or varied title options.
+    # Title Optimization: Seeking ways to improve existing titles.
+    # Comparative Analysis: Comparing and analyzing different title versions.
+    # Content Strategy: Discussing factors influencing YouTube CTR.
+    # Instructional Requests: Asking for concise, actionable recommendations.
+    # These types cover the main focus areas of your queries related to optimizing and refining YouTube content titles.
+
+    step('Thumb Text Ideas') do
+      input :video_title
+      input :video_topic_theme
+      input :content_highlights
+      input :title_ideas
+      prompt :thumbnail_text_prompt
+      output :thumbnail_text
+    end
+
+    step('Visual Element Ideas') do
+      input :video_title
+      input :content_highlights
+      input :title_ideas
+      prompt :thumbnail_visual_elements_prompt
+      output :thumbnail_visual_elements
+    end
+
+    # Does the Title, Thumbnail Text and Visual Elements align with the content or is it misleading?
+  end
+
+  section('YouTube Meta Data') do
+    step('Simple Description') do
+      input :video_title
+      input :video_keywords
+      input :abridgement
+      prompt :yt_simple_description_prompt
+      output :video_simple_description
+    end
+
+    step('Write Description') do
+      input :video_title
+      input :chapters
+      input :video_simple_description
+      input :brand_info
+      input :fold_cta
+      input :primary_cta
+      input :affiliate_cta
+      input :video_related_links
+      input :video_keywords
+      prompt :yt_description_prompt
+      output :video_description
+    end
+
+    step('Format Description') do
+      input :video_description
+      prompt :yt_format_description_prompt
+      output :video_description
+    end
+
+    step('Custom GPT Description') do
+      input :video_title
+      input :chapters
+      input :abridgement
+      input :brand_info
+      input :fold_cta
+      input :primary_cta
+      input :affiliate_cta
+      input :video_related_links
+      input :video_keywords
+      prompt :yt_description_custom_gpt_prompt
+      output :video_description_custom_gpt
+    end
+
+    step('Pinned Comment') do
+      # I don't need all these, but not sure which ones I do need yet
+      input :video_title
+      input :abridgement
+      input :chapters
+      input :brand_info
+      input :fold_cta
+      input :primary_cta
+      input :affiliate_cta
+      input :video_related_links
+      input :video_keywords
+      input :video_description
+      prompt :yt_pinned_comment_prompt
+      output :video_pinned_comment
+    end
+
+    step('Extra Metadata') do
+      input :video_title
+      input :abridgement
+      prompt :yt_metadata_prompt
+      output :video_metadata
+    end
+  end
+
+  section('Social Media Posts') do
+    step('Create Tweet') do
+      input :video_title
+      input :video_link
+      input :video_keywords
+      input :summary
+      prompt :tweet_prompt
+      output :tweet_content
+    end
+
+    step('Create FB Post') do
+      input :summary
+      input :video_keywords
+      prompt :facebook_post_prompt
+      output :facebook_post
+    end
+
+    step('Create LinkedIn Post') do
+      input :video_title
+      input :video_link
+      input :video_keywords
+      input :abridgement
+      prompt :linkedin_post_prompt
+      output :linkedin_post
+    end
+  end
+end
+
+file = '/Users/davidcruwys/dev/sites/working-with-sean/gpt-agents/src/content/gpt-workflows/youtube-launch-optimizer.json'
+dsl
+  .save
+  .save_json(file)