conductor_ruby 0.1.0

data/examples/prompt_journey.rb

@@ -0,0 +1,245 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Prompt Management Journey - Comprehensive Example
+#
+# Demonstrates all Prompt Management APIs through building an
+# AI-powered customer service system.
+#
+# APIs Covered:
+# - save_prompt, get_prompt, get_prompts, delete_prompt
+# - get_tags_for_prompt_template, update_tag_for_prompt_template, delete_tag_for_prompt_template
+# - test_prompt
+#
+# Usage:
+#   bundle exec ruby examples/prompt_journey.rb
+
+require_relative '../lib/conductor'
+
+class PromptJourney
+  AI_INTEGRATION = ENV.fetch('AI_INTEGRATION', 'openai')
+  AI_MODEL = ENV.fetch('AI_MODEL', 'gpt-4o-mini')
+
+  def initialize
+    @config = Conductor::Configuration.new
+    @clients = Conductor::Orkes::OrkesClients.new(@config)
+    @prompt_client = @clients.get_prompt_client
+    @created_prompts = []
+
+    puts '=' * 70
+    puts 'Prompt Management Journey'
+    puts '=' * 70
+    puts "Server: #{@config.server_url}"
+    puts "AI Integration: #{AI_INTEGRATION}"
+    puts
+  end
+
+  def run
+    create_prompts
+    retrieve_prompts
+    test_prompts
+    manage_tags
+    cleanup
+  end
+
+  private
+
+  def create_prompts
+    puts "\n--- Creating Prompt Templates ---"
+
+    # Customer service greeting prompt
+    greeting_prompt = <<~PROMPT
+      You are a friendly customer service representative for TechMart.
+
+      Customer Name: ${customer_name}
+      Issue Category: ${issue_category}
+
+      Please greet the customer warmly and ask how you can help them today.
+      Keep your response concise and professional.
+    PROMPT
+
+    @prompt_client.save_prompt(
+      'cs_greeting_ruby',
+      greeting_prompt,
+      description: 'Customer service greeting template'
+    )
+    @created_prompts << 'cs_greeting_ruby'
+    puts 'Created prompt: cs_greeting_ruby'
+
+    # Product recommendation prompt
+    recommendation_prompt = <<~PROMPT
+      Based on the following customer preferences, recommend 3 products:
+
+      Budget: ${budget}
+      Category: ${category}
+      Previous Purchases: ${previous_purchases}
+
+      Format your response as a numbered list with brief descriptions.
+    PROMPT
+
+    @prompt_client.save_prompt(
+      'product_recommendation_ruby',
+      recommendation_prompt,
+      description: 'Product recommendation template'
+    )
+    @created_prompts << 'product_recommendation_ruby'
+    puts 'Created prompt: product_recommendation_ruby'
+
+    # Issue resolution prompt
+    resolution_prompt = <<~PROMPT
+      You are helping resolve a customer issue.
+
+      Issue: ${issue_description}
+      Product: ${product_name}
+      Purchase Date: ${purchase_date}
+
+      Provide a helpful resolution or next steps. Be empathetic and solution-focused.
+    PROMPT
+
+    @prompt_client.save_prompt(
+      'issue_resolution_ruby',
+      resolution_prompt,
+      description: 'Issue resolution template'
+    )
+    @created_prompts << 'issue_resolution_ruby'
+    puts 'Created prompt: issue_resolution_ruby'
+  end
+
+  def retrieve_prompts
+    puts "\n--- Retrieving Prompts ---"
+
+    # Get specific prompt
+    prompt = @prompt_client.get_prompt('cs_greeting_ruby')
+    puts 'Retrieved prompt: cs_greeting_ruby'
+    puts "  Description: #{begin
+      prompt['description'] || prompt.description
+    rescue StandardError
+      'N/A'
+    end}"
+
+    # Get all prompts
+    all_prompts = @prompt_client.get_prompts
+    puts "\nAll prompts (#{all_prompts.length} total):"
+    all_prompts.first(5).each do |p|
+      name = p.is_a?(Hash) ? p['name'] : p.name
+      puts "  - #{name}"
+    end
+  end
+
+  def test_prompts
+    puts "\n--- Testing Prompts ---"
+
+    # Test the greeting prompt
+    test_input = {
+      'customer_name' => 'John Smith',
+      'issue_category' => 'Technical Support'
+    }
+
+    puts 'Testing cs_greeting_ruby with:'
+    test_input.each { |k, v| puts "  #{k}: #{v}" }
+
+    begin
+      result = @prompt_client.test_prompt(
+        'cs_greeting_ruby',
+        test_input,
+        AI_INTEGRATION,
+        AI_MODEL
+      )
+
+      puts "\nAI Response:"
+      puts '-' * 40
+      response = begin
+        result.is_a?(Hash) ? result['response'] : result.response
+      rescue StandardError
+        result
+      end
+      puts response.to_s[0..500]
+      puts '-' * 40
+    rescue Conductor::ApiError => e
+      puts "Test failed (AI integration may not be configured): #{e.message}"
+    end
+
+    # Test product recommendation
+    puts "\nTesting product_recommendation_ruby..."
+    rec_input = {
+      'budget' => '$500',
+      'category' => 'Electronics',
+      'previous_purchases' => 'Laptop, Headphones'
+    }
+
+    begin
+      result = @prompt_client.test_prompt(
+        'product_recommendation_ruby',
+        rec_input,
+        AI_INTEGRATION,
+        AI_MODEL
+      )
+      response = begin
+        result.is_a?(Hash) ? result['response'] : result.response
+      rescue StandardError
+        result
+      end
+      puts "Response preview: #{response.to_s[0..200]}..."
+    rescue Conductor::ApiError => e
+      puts "Test failed: #{e.message}"
+    end
+  end
+
+  def manage_tags
+    puts "\n--- Managing Tags ---"
+
+    tags = [
+      { 'key' => 'department', 'value' => 'customer_service' },
+      { 'key' => 'language', 'value' => 'english' },
+      { 'key' => 'version', 'value' => 'v1' }
+    ]
+
+    # Add tags
+    puts 'Adding tags to cs_greeting_ruby...'
+    @prompt_client.update_tag_for_prompt_template('cs_greeting_ruby', tags)
+
+    # Get tags
+    retrieved_tags = @prompt_client.get_tags_for_prompt_template('cs_greeting_ruby')
+    puts 'Retrieved tags:'
+    retrieved_tags.each do |tag|
+      key = tag.is_a?(Hash) ? tag['key'] : tag.key
+      value = tag.is_a?(Hash) ? tag['value'] : tag.value
+      puts "  #{key}: #{value}"
+    end
+
+    # Delete specific tag
+    puts "\nDeleting 'version' tag..."
+    @prompt_client.delete_tag_for_prompt_template(
+      'cs_greeting_ruby',
+      [{ 'key' => 'version', 'value' => 'v1' }]
+    )
+
+    # Verify deletion
+    remaining_tags = @prompt_client.get_tags_for_prompt_template('cs_greeting_ruby')
+    puts "Remaining tags: #{remaining_tags.length}"
+  end
+
+  def cleanup
+    puts "\n--- Cleanup ---"
+
+    @created_prompts.each do |name|
+      @prompt_client.delete_prompt(name)
+      puts "Deleted prompt: #{name}"
+    rescue StandardError => e
+      puts "Could not delete #{name}: #{e.message}"
+    end
+
+    puts "\nPrompt journey complete!"
+  end
+end
+
+if __FILE__ == $PROGRAM_NAME
+  begin
+    PromptJourney.new.run
+  rescue Conductor::ApiError => e
+    puts "API Error: #{e.message}"
+  rescue StandardError => e
+    puts "Error: #{e.message}"
+    puts e.backtrace.first(3).join("\n")
+  end
+end

data/examples/rag_workflow.rb

@@ -0,0 +1,167 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# RAG (Retrieval Augmented Generation) Workflow Example
+#
+# This example demonstrates a complete RAG pipeline using Conductor:
+# 1. User provides text content as workflow input
+# 2. Conductor indexes the text into a vector DB using embeddings
+# 3. A search query retrieves relevant context from the vector store
+# 4. An LLM generates an answer grounded in the retrieved context
+#
+# Prerequisites:
+# 1. Orkes Conductor server with AI/LLM support
+# 2. Configure integrations in Conductor:
+#    - Vector DB integration (e.g., "pinecone", "weaviate", "pgvector")
+#    - LLM provider (e.g., "openai", "azure_openai", "cohere")
+#
+# Usage:
+#   bundle exec ruby examples/rag_workflow.rb
+
+require_relative '../lib/conductor'
+
+include Conductor::Workflow
+
+# Configuration constants - adjust based on your integrations
+VECTOR_DB = 'pinecone'
+VECTOR_INDEX = 'demo_index'
+NAMESPACE = 'demo_namespace'
+EMBEDDING_PROVIDER = 'openai'
+EMBEDDING_MODEL = 'text-embedding-3-small'
+LLM_PROVIDER = 'openai'
+LLM_MODEL = 'gpt-4o-mini'
+
+def create_rag_workflow(workflow_client, workflow_executor)
+  workflow = ConductorWorkflow.new(
+    workflow_client,
+    'rag_pipeline_ruby',
+    version: 1,
+    executor: workflow_executor
+  )
+  workflow.description('RAG pipeline: index text -> search -> generate answer')
+  workflow.timeout_seconds(300)
+
+  # Step 1: Index the input text into vector DB
+  index_task = LlmIndexTextTask.new(
+    'index_text_ref',
+    VECTOR_DB,
+    VECTOR_INDEX,
+    namespace: NAMESPACE,
+    embedding_model: EMBEDDING_MODEL,
+    embedding_model_provider: EMBEDDING_PROVIDER
+  )
+  index_task.input('text', workflow.input('text'))
+  index_task.input('docId', workflow.input('doc_id'))
+
+  # Step 2: Wait for vector DB to commit (eventual consistency)
+  wait_task = WaitTask.new('wait_for_index', wait_for_seconds: 3)
+
+  # Step 3: Search the index with the user's question
+  search_task = LlmSearchIndexTask.new(
+    'search_index_ref',
+    VECTOR_DB,
+    VECTOR_INDEX,
+    namespace: NAMESPACE,
+    embedding_model: EMBEDDING_MODEL,
+    embedding_model_provider: EMBEDDING_PROVIDER
+  )
+  search_task.input('query', workflow.input('question'))
+  search_task.input('maxResults', 5)
+
+  # Step 4: Generate answer using retrieved context
+  system_prompt = <<~PROMPT
+    You are a helpful assistant. Answer the user's question based ONLY on the#{' '}
+    context provided below. If the context does not contain enough information, say so.
+
+    Context from knowledge base:
+    ${search_index_ref.output.result}
+  PROMPT
+
+  answer_task = LlmChatCompleteTask.new(
+    'generate_answer_ref',
+    LLM_PROVIDER,
+    LLM_MODEL,
+    messages: [
+      ChatMessage.new(role: 'system', message: system_prompt),
+      ChatMessage.new(role: 'user', message: workflow.input('question'))
+    ],
+    temperature: 0.2,
+    max_tokens: 1024
+  )
+
+  # Chain tasks
+  workflow >> index_task >> wait_task >> search_task >> answer_task
+
+  # Define outputs
+  workflow.output_parameter('retrieved_context', search_task.output('result'))
+  workflow.output_parameter('answer', answer_task.output('result'))
+
+  workflow
+end
+
+def main
+  config = Conductor::Configuration.new
+
+  puts '=' * 70
+  puts 'Conductor Ruby SDK - RAG Workflow Example'
+  puts '=' * 70
+  puts
+  puts "Server: #{config.server_url}"
+  puts "Vector DB: #{VECTOR_DB}"
+  puts "LLM Provider: #{LLM_PROVIDER}"
+  puts
+
+  clients = Conductor::Orkes::OrkesClients.new(config)
+  workflow_executor = clients.get_workflow_executor
+  workflow_client = clients.get_workflow_client
+
+  # Create and register workflow
+  workflow = create_rag_workflow(workflow_client, workflow_executor)
+  workflow_executor.register_workflow(workflow, overwrite: true)
+  puts "Registered workflow: #{workflow.name}"
+
+  # Sample document and question
+  sample_text = <<~TEXT
+    Ruby is a dynamic, open source programming language with a focus on simplicity#{' '}
+    and productivity. It has an elegant syntax that is natural to read and easy to write.
+    Ruby was created by Yukihiro "Matz" Matsumoto in the mid-1990s in Japan.
+    Ruby on Rails, often simply called Rails, is a web application framework written in Ruby.
+    Rails was created by David Heinemeier Hansson and released in 2004.
+  TEXT
+
+  question = 'Who created Ruby and when?'
+
+  puts
+  puts 'Executing RAG workflow...'
+  puts "Document: #{sample_text.length} characters"
+  puts "Question: #{question}"
+
+  result = workflow_executor.execute(
+    workflow.name,
+    input: {
+      'text' => sample_text,
+      'doc_id' => 'ruby_intro',
+      'question' => question
+    },
+    wait_for_seconds: 60
+  )
+
+  puts
+  puts '-' * 70
+  puts "Status: #{result.status}"
+  puts "Answer: #{result.output['answer']}"
+  puts '-' * 70
+  puts
+  puts "View execution: #{config.ui_host}/execution/#{result.workflow_id}"
+end
+
+if __FILE__ == $PROGRAM_NAME
+  begin
+    main
+  rescue Conductor::ApiError => e
+    puts "API Error: #{e.message}"
+  rescue StandardError => e
+    puts "Error: #{e.message}"
+    puts e.backtrace.first(3).join("\n")
+  end
+end

data/examples/schedule_journey.rb

@@ -0,0 +1,244 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Schedule Management Journey - Comprehensive Example
+#
+# Demonstrates all Scheduler APIs through building an automated
+# order processing system with scheduled workflows.
+#
+# APIs Covered:
+# - save_schedule, get_schedule, get_all_schedules, delete_schedule
+# - pause_schedule, resume_schedule, pause_all_schedules, resume_all_schedules
+# - get_next_few_schedule_execution_times, search_schedule_executions
+# - set_scheduler_tags, get_scheduler_tags, delete_scheduler_tags
+#
+# Usage:
+#   bundle exec ruby examples/schedule_journey.rb
+
+require_relative '../lib/conductor'
+
+class ScheduleJourney
+  def initialize
+    @config = Conductor::Configuration.new
+    @clients = Conductor::Orkes::OrkesClients.new(@config)
+    @scheduler = @clients.get_scheduler_client
+    @metadata = @clients.get_metadata_client
+    @created_schedules = []
+
+    puts '=' * 70
+    puts 'Schedule Management Journey'
+    puts '=' * 70
+    puts "Server: #{@config.server_url}"
+    puts
+  end
+
+  def run
+    setup_workflow
+    create_schedules
+    manage_schedules
+    work_with_tags
+    preview_and_search
+    cleanup
+  end
+
+  private
+
+  def setup_workflow
+    puts "\n--- Setting up test workflow ---"
+
+    # Create a simple workflow for scheduling
+    workflow_def = Conductor::Http::Models::WorkflowDef.new(
+      name: 'scheduled_order_processor',
+      version: 1,
+      description: 'Process orders on schedule',
+      tasks: [
+        {
+          'name' => 'process_orders',
+          'taskReferenceName' => 'process_ref',
+          'type' => 'HTTP',
+          'inputParameters' => {
+            'http_request' => {
+              'uri' => 'https://httpbin.org/post',
+              'method' => 'POST',
+              'body' => { 'timestamp' => '${workflow.input.timestamp}' }
+            }
+          }
+        }
+      ]
+    )
+
+    @metadata.register_workflow_def(workflow_def, overwrite: true)
+    puts "Created workflow: #{workflow_def.name}"
+  end
+
+  def create_schedules
+    puts "\n--- Creating Schedules ---"
+
+    # Schedule 1: Every minute (for demo)
+    schedule1 = {
+      'name' => 'order_processor_minutely',
+      'cronExpression' => '0 * * * * ?', # Every minute
+      'startWorkflowRequest' => {
+        'name' => 'scheduled_order_processor',
+        'version' => 1,
+        'input' => { 'type' => 'minutely' }
+      },
+      'paused' => true, # Start paused for demo
+      'scheduleStartTime' => (Time.now.to_i * 1000),
+      'zoneId' => 'America/New_York'
+    }
+
+    @scheduler.save_schedule(schedule1)
+    @created_schedules << schedule1['name']
+    puts "Created schedule: #{schedule1['name']} (every minute)"
+
+    # Schedule 2: Daily at midnight
+    schedule2 = {
+      'name' => 'order_processor_daily',
+      'cronExpression' => '0 0 0 * * ?', # Daily at midnight
+      'startWorkflowRequest' => {
+        'name' => 'scheduled_order_processor',
+        'version' => 1,
+        'input' => { 'type' => 'daily' }
+      },
+      'paused' => true
+    }
+
+    @scheduler.save_schedule(schedule2)
+    @created_schedules << schedule2['name']
+    puts "Created schedule: #{schedule2['name']} (daily at midnight)"
+
+    # Schedule 3: Weekly on Monday
+    schedule3 = {
+      'name' => 'order_processor_weekly',
+      'cronExpression' => '0 0 9 ? * MON', # Monday at 9 AM
+      'startWorkflowRequest' => {
+        'name' => 'scheduled_order_processor',
+        'version' => 1,
+        'input' => { 'type' => 'weekly' }
+      },
+      'paused' => true
+    }
+
+    @scheduler.save_schedule(schedule3)
+    @created_schedules << schedule3['name']
+    puts "Created schedule: #{schedule3['name']} (weekly on Monday)"
+  end
+
+  def manage_schedules
+    puts "\n--- Managing Schedules ---"
+
+    # Get a specific schedule
+    schedule = @scheduler.get_schedule('order_processor_minutely')
+    puts "Retrieved schedule: #{schedule['name']}"
+    puts "  Cron: #{schedule['cronExpression']}"
+    puts "  Paused: #{schedule['paused']}"
+
+    # Get all schedules
+    all_schedules = @scheduler.get_all_schedules
+    puts "\nAll schedules (#{all_schedules.length} total):"
+    all_schedules.first(5).each do |s|
+      name = s.is_a?(Hash) ? s['name'] : s.name
+      puts "  - #{name}"
+    end
+
+    # Pause and resume individual schedule
+    puts "\nPausing order_processor_minutely..."
+    @scheduler.pause_schedule('order_processor_minutely')
+
+    puts 'Resuming order_processor_minutely...'
+    begin
+      @scheduler.resume_schedule('order_processor_minutely')
+    rescue Conductor::ApiError => e
+      puts "  Note: #{e.message}" if e.message.include?('404')
+    end
+
+    # Pause all schedules
+    puts "\nPausing all schedules..."
+    @scheduler.pause_all_schedules
+
+    # Resume all schedules
+    puts 'Resuming all schedules...'
+    @scheduler.resume_all_schedules
+  end
+
+  def work_with_tags
+    puts "\n--- Working with Tags ---"
+
+    tags = [
+      { 'key' => 'environment', 'value' => 'production' },
+      { 'key' => 'team', 'value' => 'orders' }
+    ]
+
+    # Set tags
+    puts 'Setting tags on order_processor_daily...'
+    @scheduler.set_scheduler_tags(tags, 'order_processor_daily')
+
+    # Get tags
+    retrieved_tags = @scheduler.get_scheduler_tags('order_processor_daily')
+    puts 'Retrieved tags:'
+    retrieved_tags.each do |tag|
+      key = tag.is_a?(Hash) ? tag['key'] : tag.key
+      value = tag.is_a?(Hash) ? tag['value'] : tag.value
+      puts "  #{key}: #{value}"
+    end
+
+    # Delete tags
+    puts 'Deleting tags...'
+    @scheduler.delete_scheduler_tags(tags, 'order_processor_daily')
+  end
+
+  def preview_and_search
+    puts "\n--- Preview and Search ---"
+
+    # Get next execution times
+    puts 'Next 5 execution times for order_processor_minutely:'
+    begin
+      times = @scheduler.get_next_few_schedule_execution_times(
+        '0 * * * * ?',
+        limit: 5
+      )
+      times.first(5).each { |t| puts "  - #{Time.at(t / 1000)}" }
+    rescue StandardError => e
+      puts "  Could not get execution times: #{e.message}"
+    end
+
+    # Search executions
+    puts "\nSearching schedule executions..."
+    begin
+      results = @scheduler.search_schedule_executions(
+        start: 0,
+        size: 10,
+        query: '*:*'
+      )
+      count = results.is_a?(Hash) ? results['totalHits'] : results.total_hits
+      puts "Found #{count || 0} executions"
+    rescue StandardError => e
+      puts "  Search returned: #{e.message}"
+    end
+  end
+
+  def cleanup
+    puts "\n--- Cleanup ---"
+
+    @created_schedules.each do |name|
+      @scheduler.delete_schedule(name)
+      puts "Deleted schedule: #{name}"
+    rescue StandardError => e
+      puts "Could not delete #{name}: #{e.message}"
+    end
+
+    puts "\nSchedule journey complete!"
+  end
+end
+
+if __FILE__ == $PROGRAM_NAME
+  begin
+    ScheduleJourney.new.run
+  rescue Conductor::ApiError => e
+    puts "API Error: #{e.message}"
+  rescue StandardError => e
+    puts "Error: #{e.message}"
+    puts e.backtrace.first(3).join("\n")
+  end
+end