exa-ai 0.3.0 → 0.4.0

data/exe/exa-ai-enrichment-get

@@ -0,0 +1,103 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "exa-ai"
+
+# Parse arguments
+webset_id = nil
+enrichment_id = nil
+api_key = nil
+output_format = "json"
+
+args = ARGV.dup
+while args.any?
+  arg = args.shift
+  case arg
+  when "--api-key"
+    api_key = args.shift
+  when "--output-format"
+    output_format = args.shift
+  when "--help", "-h"
+    puts <<~HELP
+      Usage: exa-ai enrichment-get <webset_id> <enrichment_id> [OPTIONS]
+
+      Retrieve details for an enrichment
+
+      Arguments:
+        webset_id              ID of the webset (required)
+        enrichment_id          ID of the enrichment to retrieve (required)
+
+      Options:
+        --api-key KEY          Exa API key (or set EXA_API_KEY env var)
+        --output-format FMT    Output format: json, pretty, or text (default: json)
+        --help, -h             Show this help message
+
+      Examples:
+        exa-ai enrichment-get ws_123 enr_456
+        exa-ai enrichment-get ws_123 enr_456 --output-format pretty
+    HELP
+    exit 0
+  else
+    # First positional argument is webset_id, second is enrichment_id
+    if webset_id.nil?
+      webset_id = arg
+    elsif enrichment_id.nil?
+      enrichment_id = arg
+    else
+      $stderr.puts "Unknown option: #{arg}"
+      exit 1
+    end
+  end
+end
+
+# Validate
+if webset_id.nil?
+  $stderr.puts "Error: webset_id argument is required"
+  $stderr.puts "Usage: exa-ai enrichment-get <webset_id> <enrichment_id> [OPTIONS]"
+  $stderr.puts "Try 'exa-ai enrichment-get --help' for more information"
+  exit 1
+end
+
+if enrichment_id.nil?
+  $stderr.puts "Error: enrichment_id argument is required"
+  $stderr.puts "Usage: exa-ai enrichment-get <webset_id> <enrichment_id> [OPTIONS]"
+  $stderr.puts "Try 'exa-ai enrichment-get --help' for more information"
+  exit 1
+end
+
+begin
+  # Resolve API key and format
+  api_key = Exa::CLI::Base.resolve_api_key(api_key)
+  output_format = Exa::CLI::Base.resolve_output_format(output_format)
+
+  # Build client
+  client = Exa::CLI::Base.build_client(api_key)
+
+  # Get enrichment
+  enrichment = client.get_enrichment(webset_id: webset_id, id: enrichment_id)
+
+  # Format and output
+  output = Exa::CLI::Formatters::EnrichmentFormatter.format(enrichment, output_format)
+  puts output
+
+rescue Exa::NotFound => e
+  $stderr.puts "Enrichment not found: #{e.message}"
+  exit 1
+rescue Exa::Unauthorized => e
+  $stderr.puts "Authentication error: #{e.message}"
+  $stderr.puts "Check your API key (set EXA_API_KEY or use --api-key)"
+  exit 1
+rescue Exa::ClientError => e
+  $stderr.puts "Client error: #{e.message}"
+  exit 1
+rescue Exa::ServerError => e
+  $stderr.puts "Server error: #{e.message}"
+  exit 1
+rescue Exa::Error => e
+  $stderr.puts "Error: #{e.message}"
+  exit 1
+rescue StandardError => e
+  $stderr.puts "Unexpected error: #{e.message}"
+  $stderr.puts e.backtrace.first(5) if ENV["DEBUG"]
+  exit 1
+end

data/exe/exa-ai-enrichment-list

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "exa-ai"
+
+# Parse arguments
+webset_id = nil
+api_key = nil
+output_format = "json"
+
+args = ARGV.dup
+while args.any?
+  arg = args.shift
+  case arg
+  when "--api-key"
+    api_key = args.shift
+  when "--output-format"
+    output_format = args.shift
+  when "--help", "-h"
+    puts <<~HELP
+      Usage: exa-ai enrichment-list <webset_id> [OPTIONS]
+
+      List all enrichments for a webset
+
+      Arguments:
+        webset_id              ID of the webset (required)
+
+      Options:
+        --api-key KEY          Exa API key (or set EXA_API_KEY env var)
+        --output-format FMT    Output format: json, pretty, or text (default: json)
+        --help, -h             Show this help message
+
+      Examples:
+        exa-ai enrichment-list ws_123
+        exa-ai enrichment-list ws_123 --output-format text
+    HELP
+    exit 0
+  else
+    # First positional argument is webset_id
+    if webset_id.nil?
+      webset_id = arg
+    else
+      $stderr.puts "Unknown option: #{arg}"
+      exit 1
+    end
+  end
+end
+
+# Validate
+if webset_id.nil?
+  $stderr.puts "Error: webset_id argument is required"
+  $stderr.puts "Usage: exa-ai enrichment-list <webset_id> [OPTIONS]"
+  $stderr.puts "Try 'exa-ai enrichment-list --help' for more information"
+  exit 1
+end
+
+begin
+  # Resolve API key and format
+  api_key = Exa::CLI::Base.resolve_api_key(api_key)
+  output_format = Exa::CLI::Base.resolve_output_format(output_format)
+
+  # Build client
+  client = Exa::CLI::Base.build_client(api_key)
+
+  # Get webset to retrieve enrichments
+  webset = client.get_webset(webset_id)
+
+  # Extract enrichments array (or empty array if none)
+  enrichments_data = webset.enrichments || []
+
+  # Create collection
+  collection = Exa::Resources::WebsetEnrichmentCollection.new(data: enrichments_data)
+
+  # Format and output
+  output = Exa::CLI::Formatters::EnrichmentFormatter.format_collection(collection, output_format)
+  puts output
+
+rescue Exa::NotFound => e
+  $stderr.puts "Webset not found: #{e.message}"
+  exit 1
+rescue Exa::Unauthorized => e
+  $stderr.puts "Authentication error: #{e.message}"
+  $stderr.puts "Check your API key (set EXA_API_KEY or use --api-key)"
+  exit 1
+rescue Exa::ClientError => e
+  $stderr.puts "Client error: #{e.message}"
+  exit 1
+rescue Exa::ServerError => e
+  $stderr.puts "Server error: #{e.message}"
+  exit 1
+rescue Exa::Error => e
+  $stderr.puts "Error: #{e.message}"
+  exit 1
+rescue StandardError => e
+  $stderr.puts "Unexpected error: #{e.message}"
+  $stderr.puts e.backtrace.first(5) if ENV["DEBUG"]
+  exit 1
+end

data/exe/exa-ai-enrichment-update

@@ -0,0 +1,170 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "exa-ai"
+require "json"
+
+# Recursively convert hash keys from strings to symbols
+def deep_symbolize_keys(obj)
+  case obj
+  when Hash
+    obj.each_with_object({}) do |(key, value), result|
+      result[key.to_sym] = deep_symbolize_keys(value)
+    end
+  when Array
+    obj.map { |item| deep_symbolize_keys(item) }
+  else
+    obj
+  end
+end
+
+# Helper to parse JSON string or load from file
+def parse_json_or_file(value)
+  json_data = if value.start_with?("@")
+                file_path = value[1..]
+                JSON.parse(File.read(file_path))
+              else
+                JSON.parse(value)
+              end
+  deep_symbolize_keys(json_data)
+rescue JSON::ParserError => e
+  $stderr.puts "Error: Invalid JSON: #{e.message}"
+  exit 1
+rescue Errno::ENOENT => e
+  $stderr.puts "Error: File not found: #{e.message}"
+  exit 1
+end
+
+# Parse arguments
+webset_id = nil
+enrichment_id = nil
+description = nil
+format = nil
+options = nil
+metadata = nil
+api_key = nil
+output_format = "json"
+
+args = ARGV.dup
+while args.any?
+  arg = args.shift
+  case arg
+  when "--description"
+    description = args.shift
+  when "--format"
+    format = args.shift
+  when "--options"
+    options = parse_json_or_file(args.shift)
+  when "--metadata"
+    metadata = parse_json_or_file(args.shift)
+  when "--api-key"
+    api_key = args.shift
+  when "--output-format"
+    output_format = args.shift
+  when "--help", "-h"
+    puts <<~HELP
+      Usage: exa-ai enrichment-update <webset_id> <enrichment_id> [OPTIONS]
+
+      Update an enrichment's properties
+
+      Arguments:
+        webset_id              ID of the webset (required)
+        enrichment_id          ID of the enrichment to update (required)
+
+      Options:
+        --description TEXT     What to extract
+        --format TYPE          One of: text, url, options
+        --options JSON         Array of {label: "..."} (supports @file.json)
+        --metadata JSON        Custom metadata (supports @file.json)
+        --api-key KEY          Exa API key (or set EXA_API_KEY env var)
+        --output-format FMT    Output format: json, pretty, or text (default: json)
+        --help, -h             Show this help message
+
+      Examples:
+        exa-ai enrichment-update ws_123 enr_456 --description "New description"
+        exa-ai enrichment-update ws_123 enr_456 --metadata '{"priority":"high"}'
+        exa-ai enrichment-update ws_123 enr_456 --options options.json --format options
+    HELP
+    exit 0
+  else
+    # First positional argument is webset_id, second is enrichment_id
+    if webset_id.nil?
+      webset_id = arg
+    elsif enrichment_id.nil?
+      enrichment_id = arg
+    else
+      $stderr.puts "Unknown option: #{arg}"
+      exit 1
+    end
+  end
+end
+
+# Validate required arguments
+if webset_id.nil?
+  $stderr.puts "Error: webset_id argument is required"
+  $stderr.puts "Usage: exa-ai enrichment-update <webset_id> <enrichment_id> [OPTIONS]"
+  $stderr.puts "Try 'exa-ai enrichment-update --help' for more information"
+  exit 1
+end
+
+if enrichment_id.nil?
+  $stderr.puts "Error: enrichment_id argument is required"
+  $stderr.puts "Usage: exa-ai enrichment-update <webset_id> <enrichment_id> [OPTIONS]"
+  $stderr.puts "Try 'exa-ai enrichment-update --help' for more information"
+  exit 1
+end
+
+# Check that at least one update field is provided
+if description.nil? && format.nil? && options.nil? && metadata.nil?
+  $stderr.puts "Error: at least one update field is required (--description, --format, --options, or --metadata)"
+  $stderr.puts "Try 'exa-ai enrichment-update --help' for more information"
+  exit 1
+end
+
+begin
+  # Resolve API key and format
+  api_key = Exa::CLI::Base.resolve_api_key(api_key)
+  output_format = Exa::CLI::Base.resolve_output_format(output_format)
+
+  # Build client
+  client = Exa::CLI::Base.build_client(api_key)
+
+  # Build update params (only include provided fields)
+  update_params = {}
+  update_params[:description] = description if description
+  update_params[:format] = format if format
+  update_params[:options] = options if options
+  update_params[:metadata] = metadata if metadata
+
+  # Update enrichment
+  enrichment = client.update_enrichment(webset_id: webset_id, id: enrichment_id, **update_params)
+
+  # Format and output
+  output = Exa::CLI::Formatters::EnrichmentFormatter.format(enrichment, output_format)
+  puts output
+
+rescue Exa::NotFound => e
+  $stderr.puts "Enrichment not found: #{e.message}"
+  exit 1
+rescue Exa::ConfigurationError => e
+  $stderr.puts "Configuration error: #{e.message}"
+  exit 1
+rescue Exa::Unauthorized => e
+  $stderr.puts "Authentication error: #{e.message}"
+  $stderr.puts "Check your API key (set EXA_API_KEY or use --api-key)"
+  exit 1
+rescue Exa::ClientError => e
+  $stderr.puts "Client error: #{e.message}"
+  exit 1
+rescue Exa::ServerError => e
+  $stderr.puts "Server error: #{e.message}"
+  $stderr.puts "The Exa API may be experiencing issues. Please try again later."
+  exit 1
+rescue Exa::Error => e
+  $stderr.puts "Error: #{e.message}"
+  exit 1
+rescue StandardError => e
+  $stderr.puts "Unexpected error: #{e.message}"
+  $stderr.puts e.backtrace.first(5) if ENV["DEBUG"]
+  exit 1
+end

data/exe/exa-ai-find-similar

@@ -0,0 +1,240 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "exa-ai"
+
+# Parse command-line arguments
+def parse_args(argv)
+  args = {
+    output_format: "json",
+    api_key: nil
+  }
+
+  # Extract URL (first non-flag argument)
+  url_found = false
+  i = 0
+  while i < argv.length
+    arg = argv[i]
+    case arg
+    when "--num-results"
+      args[:num_results] = argv[i + 1].to_i
+      i += 2
+    when "--exclude-source-domain"
+      args[:exclude_source_domain] = true
+      i += 1
+    when "--category"
+      category = argv[i + 1]
+      valid_categories = ["company", "research paper", "news", "pdf", "github", "tweet", "personal site", "linkedin profile", "financial report"]
+      unless valid_categories.include?(category)
+        $stderr.puts "Error: Category must be one of: #{valid_categories.map { |c| "\"#{c}\"" }.join(', ')}"
+        exit 1
+      end
+      args[:category] = category
+      i += 2
+    when "--include-domains"
+      args[:include_domains] = argv[i + 1].split(",").map(&:strip)
+      i += 2
+    when "--exclude-domains"
+      args[:exclude_domains] = argv[i + 1].split(",").map(&:strip)
+      i += 2
+    when "--start-published-date"
+      args[:start_published_date] = argv[i + 1]
+      i += 2
+    when "--end-published-date"
+      args[:end_published_date] = argv[i + 1]
+      i += 2
+    when "--start-crawl-date"
+      args[:start_crawl_date] = argv[i + 1]
+      i += 2
+    when "--end-crawl-date"
+      args[:end_crawl_date] = argv[i + 1]
+      i += 2
+    when "--include-text"
+      args[:include_text] ||= []
+      args[:include_text] << argv[i + 1]
+      i += 2
+    when "--exclude-text"
+      args[:exclude_text] ||= []
+      args[:exclude_text] << argv[i + 1]
+      i += 2
+    when "--text"
+      args[:text] = true
+      i += 1
+    when "--text-max-characters"
+      args[:text_max_characters] = argv[i + 1].to_i
+      i += 2
+    when "--include-html-tags"
+      args[:include_html_tags] = true
+      i += 1
+    when "--summary"
+      args[:summary] = true
+      i += 1
+    when "--summary-query"
+      args[:summary_query] = argv[i + 1]
+      i += 2
+    when "--summary-schema"
+      schema_arg = argv[i + 1]
+      args[:summary_schema] = if schema_arg.start_with?("@")
+                               JSON.parse(File.read(schema_arg[1..]))
+                             else
+                               JSON.parse(schema_arg)
+                             end
+      i += 2
+    when "--api-key"
+      args[:api_key] = argv[i + 1]
+      i += 2
+    when "--output-format"
+      args[:output_format] = argv[i + 1]
+      i += 2
+    when "--help", "-h"
+      puts <<~HELP
+        Usage: exa-ai find-similar URL [OPTIONS]
+
+        Find content similar to a given URL
+
+        Arguments:
+          URL                       URL to find similar content for (required)
+
+        Options:
+          --num-results N              Number of results to return (default: 10)
+          --exclude-source-domain      Exclude results from the source URL's domain
+          --category CAT               Focus on specific data category
+                                       Options: "company", "research paper", "news", "pdf",
+                                       "github", "tweet", "personal site", "linkedin profile",
+                                       "financial report"
+          --include-domains D          Comma-separated list of domains to include
+          --exclude-domains D          Comma-separated list of domains to exclude
+          --start-published-date DATE  Filter by published date (ISO 8601 format)
+          --end-published-date DATE    Filter by published date (ISO 8601 format)
+          --start-crawl-date DATE      Filter by crawl date (ISO 8601 format)
+          --end-crawl-date DATE        Filter by crawl date (ISO 8601 format)
+          --include-text PHRASE        Include results with exact phrase (repeatable)
+          --exclude-text PHRASE        Exclude results with exact phrase (repeatable)
+
+        Content Extraction:
+          --text                       Include full webpage text
+          --text-max-characters N      Max characters for webpage text
+          --include-html-tags          Include HTML tags in text extraction
+          --summary                    Include AI-generated summary
+          --summary-query PROMPT       Custom prompt for summary generation
+          --summary-schema FILE        JSON schema for summary structure (@file syntax)
+
+        General Options:
+          --api-key KEY                Exa API key (or set EXA_API_KEY env var)
+          --output-format FMT          Output format: json, pretty, or text (default: json)
+          --help, -h                   Show this help message
+
+        Examples:
+          exa-ai find-similar "https://example.com/article"
+          exa-ai find-similar "https://techcrunch.com/ai-startup" --num-results 5
+          exa-ai find-similar "https://arxiv.org/paper" --category "research paper"
+          exa-ai find-similar "https://example.com" --exclude-source-domain
+          exa-ai find-similar "https://example.com" --output-format pretty
+      HELP
+      exit 0
+    else
+      unless url_found
+        args[:url] = arg
+        url_found = true
+      end
+      i += 1
+    end
+  end
+
+  args
+end
+
+# Build contents parameter from extracted flags
+def build_contents(args)
+  contents = {}
+
+  # Text options
+  if args[:text]
+    if args[:text_max_characters] || args[:include_html_tags]
+      contents[:text] = {}
+      contents[:text][:max_characters] = args[:text_max_characters] if args[:text_max_characters]
+      contents[:text][:include_html_tags] = args[:include_html_tags] if args[:include_html_tags]
+    else
+      contents[:text] = true
+    end
+  end
+
+  # Summary options
+  if args[:summary]
+    if args[:summary_query] || args[:summary_schema]
+      contents[:summary] = {}
+      contents[:summary][:query] = args[:summary_query] if args[:summary_query]
+      contents[:summary][:schema] = args[:summary_schema] if args[:summary_schema]
+    else
+      contents[:summary] = true
+    end
+  end
+
+  contents.empty? ? nil : contents
+end
+
+# Main execution
+begin
+  args = parse_args(ARGV)
+
+  # Validate URL
+  if args[:url].nil? || args[:url].empty?
+    $stderr.puts "Error: URL is required"
+    $stderr.puts "Run 'exa-ai find-similar --help' for usage information"
+    exit 1
+  end
+
+  # Resolve API key
+  api_key = Exa::CLI::Base.resolve_api_key(args[:api_key])
+
+  # Resolve output format
+  output_format = Exa::CLI::Base.resolve_output_format(args[:output_format])
+
+  # Build client
+  client = Exa::CLI::Base.build_client(api_key)
+
+  # Prepare parameters
+  params = {}
+  params[:numResults] = args[:num_results] if args[:num_results]
+  params[:excludeSourceDomain] = args[:exclude_source_domain] if args[:exclude_source_domain]
+  params[:category] = args[:category] if args[:category]
+  params[:includeDomains] = args[:include_domains] if args[:include_domains]
+  params[:excludeDomains] = args[:exclude_domains] if args[:exclude_domains]
+  params[:start_published_date] = args[:start_published_date] if args[:start_published_date]
+  params[:end_published_date] = args[:end_published_date] if args[:end_published_date]
+  params[:start_crawl_date] = args[:start_crawl_date] if args[:start_crawl_date]
+  params[:end_crawl_date] = args[:end_crawl_date] if args[:end_crawl_date]
+  params[:include_text] = args[:include_text] if args[:include_text]
+  params[:exclude_text] = args[:exclude_text] if args[:exclude_text]
+  contents = build_contents(args)
+  params.merge!(contents) if contents
+
+  # Execute find_similar
+  result = client.find_similar(args[:url], **params)
+
+  # Format and output result
+  output = Exa::CLI::Formatters::SearchFormatter.format(result, output_format)
+  puts output
+
+rescue Exa::ConfigurationError => e
+  $stderr.puts "Configuration error: #{e.message}"
+  exit 1
+rescue Exa::Unauthorized => e
+  $stderr.puts "Authentication error: #{e.message}"
+  $stderr.puts "Check your API key (set EXA_API_KEY or use --api-key)"
+  exit 1
+rescue Exa::ClientError => e
+  $stderr.puts "Client error: #{e.message}"
+  exit 1
+rescue Exa::ServerError => e
+  $stderr.puts "Server error: #{e.message}"
+  $stderr.puts "The Exa API may be experiencing issues. Please try again later."
+  exit 1
+rescue Exa::Error => e
+  $stderr.puts "Error: #{e.message}"
+  exit 1
+rescue StandardError => e
+  $stderr.puts "Unexpected error: #{e.message}"
+  $stderr.puts e.backtrace.first(5) if ENV["DEBUG"]
+  exit 1
+end

data/exe/exa-ai-get-contents

@@ -1,10 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "exa"
-require "exa/cli/base"
-require "exa/cli/formatters/contents_formatter"
+require "exa-ai"
 
 # Parse command line arguments
 def parse_args(args)

data/exe/exa-ai-research-get

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "exa"
+require "exa-ai"
 
 # Parse command-line arguments
 api_key = nil

data/exe/exa-ai-research-list

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "exa"
+require "exa-ai"
 
 # Parse command-line arguments
 api_key = nil

data/exe/exa-ai-research-start

@@ -1,9 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Set up load paths
-require "bundler/setup"
-require "exa"
+require "exa-ai"
 
 # Parse command-line arguments
 def parse_args(argv)

data/exe/exa-ai-search

@@ -1,9 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Set up load paths
-require "bundler/setup"
-require "exa"
+require "exa-ai"
 
 # Parse command-line arguments
 def parse_args(argv)