exa-ai 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 192ebafa0e355cadad770196faef4841992b4f9ea9f115526edd09b26ef786ec
-  data.tar.gz: 01c5dfd469dceea4108ba22a91ba2f03941908a3509b6241f4b0e0e63f3e09e9
+  metadata.gz: ffa1108ddff0ff951dc18d12eeef57f74020a4c0425916a394fac95e4699fef5
+  data.tar.gz: 43c40cc61a7bee139dc3c179fe9d11c40b04dd506d53c22f88e312705ae9dfe3
 SHA512:
-  metadata.gz: 2bb8c7dcb3c1940ca2ab84eef4a6f08b93f65a23cf86547b2736e0eefd1dbc012d954dca5626f0c723f28d4527de4112cab46972546bb725c01f0ad0946a6e3e
-  data.tar.gz: 3b232fe9fa3a95aa86553825373f2b6596910edc84144af3995486c90a96f6f6ea92590cda6420b2069e2dee9a5173b61089bc32257ec1ab22158eaa39ad2fa8
+  metadata.gz: 5745df2cf4664fff7b8a507fb82662cd1e448a51dba7a0a0ac30485d624ac1bb3624e85b6086a6bd511a9485636b0d5a9804c561e9476106679a7458572fcf62
+  data.tar.gz: 637d5150a3b0d192b1c68288c83c4e0ad13827d4d60ac9deb4a974397ab9b0c2ab86dd9281f33bc11dc5e1fd7ba06b22daa4c8d0f80c8927c108946e4c8ffe46

data/exe/exa-ai-search

@@ -15,7 +15,8 @@ def print_help
 
     Options:
       --num-results N              Number of results to return (default: 10)
-      --type TYPE                  Search type: fast, deep, keyword, or auto (default: fast)
+      --type TYPE                  Search type: auto, neural, fast, deep, deep-reasoning,
+                                   or instant (default: auto)
       --category CAT               Focus on specific data category
                                    Options: "company", "research paper", "news", "pdf",
                                    "github", "tweet", "personal site", "financial report",
@@ -42,6 +43,19 @@ def print_help
       --subpage-target PHRASE      Subpage target phrases (repeatable)
       --links N                    Number of links to extract per result
       --image-links N              Number of image links to extract
+      --highlights                 Include text highlights in results
+      --highlights-max-characters N  Max characters per highlight
+      --highlights-num-sentences N   Number of sentences per highlight
+      --highlights-per-url N       Number of highlights per URL
+      --highlights-query QUERY     Custom query for highlight extraction
+      --livecrawl MODE             Livecrawl mode: always, fallback, never, auto, or preferred
+      --livecrawl-timeout N        Livecrawl timeout in milliseconds
+      --max-age-hours N            Maximum age of results in hours
+
+    Search Options:
+      --additional-queries QUERY   Additional search queries (repeatable)
+      --output-schema JSON         JSON schema for output structure (@file syntax)
+      --user-location CODE         User location (ISO country code)
 
     General Options:
       --api-key KEY                Exa API key (or set EXA_API_KEY env var)
@@ -105,6 +119,25 @@ def build_contents(args)
     contents[:extras][:image_links] = args[:image_links] if args[:image_links]
   end
 
+  # Highlights options
+  if args[:highlights]
+    highlight_opts = %i[highlights_max_characters highlights_num_sentences highlights_per_url highlights_query]
+    if highlight_opts.any? { |k| args[k] }
+      contents[:highlights] = {}
+      contents[:highlights][:max_characters] = args[:highlights_max_characters] if args[:highlights_max_characters]
+      contents[:highlights][:num_sentences] = args[:highlights_num_sentences] if args[:highlights_num_sentences]
+      contents[:highlights][:highlights_per_url] = args[:highlights_per_url] if args[:highlights_per_url]
+      contents[:highlights][:query] = args[:highlights_query] if args[:highlights_query]
+    else
+      contents[:highlights] = true
+    end
+  end
+
+  # Livecrawl options
+  contents[:livecrawl] = args[:livecrawl] if args[:livecrawl]
+  contents[:livecrawl_timeout] = args[:livecrawl_timeout] if args[:livecrawl_timeout]
+  contents[:max_age_hours] = args[:max_age_hours] if args[:max_age_hours]
+
   contents.empty? ? nil : contents
 end
 
@@ -130,17 +163,20 @@ begin
 
   # Prepare search parameters
   search_params = {}
-  search_params[:numResults] = args[:num_results] if args[:num_results]
+  search_params[:num_results] = args[:num_results] if args[:num_results]
   search_params[:type] = args[:type] if args[:type]
   search_params[:category] = args[:category] if args[:category]
-  search_params[:includeDomains] = args[:include_domains] if args[:include_domains]
-  search_params[:excludeDomains] = args[:exclude_domains] if args[:exclude_domains]
+  search_params[:include_domains] = args[:include_domains] if args[:include_domains]
+  search_params[:exclude_domains] = args[:exclude_domains] if args[:exclude_domains]
   search_params[:start_published_date] = args[:start_published_date] if args[:start_published_date]
   search_params[:end_published_date] = args[:end_published_date] if args[:end_published_date]
   search_params[:start_crawl_date] = args[:start_crawl_date] if args[:start_crawl_date]
   search_params[:end_crawl_date] = args[:end_crawl_date] if args[:end_crawl_date]
   search_params[:include_text] = args[:include_text] if args[:include_text]
   search_params[:exclude_text] = args[:exclude_text] if args[:exclude_text]
+  search_params[:additional_queries] = args[:additional_queries] if args[:additional_queries]
+  search_params[:output_schema] = args[:output_schema] if args[:output_schema]
+  search_params[:user_location] = args[:user_location] if args[:user_location]
   contents = build_contents(args)
   search_params.merge!(contents) if contents
 

data/lib/exa/cli/search_parser.rb

@@ -3,7 +3,8 @@
 module Exa
   module CLI
     class SearchParser
-      VALID_SEARCH_TYPES = ["fast", "deep", "keyword", "auto"].freeze
+      VALID_SEARCH_TYPES = ["auto", "neural", "fast", "deep", "deep-reasoning", "instant"].freeze
+      VALID_LIVECRAWL_MODES = ["always", "fallback", "never", "auto", "preferred"].freeze
       VALID_CATEGORIES = [
         "company", "research paper", "news", "pdf", "github",
         "tweet", "personal site", "financial report", "people"
@@ -123,6 +124,47 @@ module Exa
           when "--image-links"
             @args[:image_links] = @argv[i + 1].to_i
             i += 2
+          when "--highlights"
+            @args[:highlights] = true
+            i += 1
+          when "--highlights-max-characters"
+            @args[:highlights_max_characters] = @argv[i + 1].to_i
+            i += 2
+          when "--highlights-num-sentences"
+            @args[:highlights_num_sentences] = @argv[i + 1].to_i
+            i += 2
+          when "--highlights-per-url"
+            @args[:highlights_per_url] = @argv[i + 1].to_i
+            i += 2
+          when "--highlights-query"
+            @args[:highlights_query] = @argv[i + 1]
+            i += 2
+          when "--livecrawl"
+            livecrawl = @argv[i + 1]
+            validate_livecrawl(livecrawl)
+            @args[:livecrawl] = livecrawl
+            i += 2
+          when "--livecrawl-timeout"
+            @args[:livecrawl_timeout] = @argv[i + 1].to_i
+            i += 2
+          when "--max-age-hours"
+            @args[:max_age_hours] = @argv[i + 1].to_i
+            i += 2
+          when "--additional-queries"
+            @args[:additional_queries] ||= []
+            @args[:additional_queries] << @argv[i + 1]
+            i += 2
+          when "--output-schema"
+            schema_arg = @argv[i + 1]
+            @args[:output_schema] = if schema_arg.start_with?("@")
+                                      JSON.parse(File.read(schema_arg[1..]))
+                                    else
+                                      JSON.parse(schema_arg)
+                                    end
+            i += 2
+          when "--user-location"
+            @args[:user_location] = @argv[i + 1]
+            i += 2
           else
             query_parts << arg
             i += 1
@@ -142,6 +184,12 @@ module Exa
         raise ArgumentError, "Search type must be one of: #{VALID_SEARCH_TYPES.join(', ')}"
       end
 
+      def validate_livecrawl(mode)
+        return if VALID_LIVECRAWL_MODES.include?(mode)
+
+        raise ArgumentError, "Livecrawl mode must be one of: #{VALID_LIVECRAWL_MODES.join(', ')}"
+      end
+
       def validate_category(category)
         return if VALID_CATEGORIES.include?(category)
 

data/lib/exa/resources/search_result.rb

@@ -11,9 +11,10 @@ module Exa
       :search_type,
       :context,
       :cost_dollars,
+      :output,
       keyword_init: true
     )
-      def initialize(results:, request_id: nil, resolved_search_type: nil, search_type: nil, context: nil, cost_dollars: nil)
+      def initialize(results:, request_id: nil, resolved_search_type: nil, search_type: nil, context: nil, cost_dollars: nil, output: nil)
         super
         freeze
       end

data/lib/exa/services/parameter_converter.rb

@@ -36,18 +36,26 @@ module Exa
         when :include_text then :includeText
         when :exclude_text then :excludeText
         when :external_id then :externalId
+        when :additional_queries then :additionalQueries
+        when :output_schema then :outputSchema
+        when :user_location then :userLocation
+        when :num_results then :numResults
+        when :include_domains then :includeDomains
+        when :exclude_domains then :excludeDomains
         else
           key
         end
       end
 
       def content_key?(key)
-        %i[text summary context subpages subpage_target extras].include?(key)
+        %i[text summary context subpages subpage_target extras highlights livecrawl livecrawl_timeout max_age_hours].include?(key)
       end
 
       def convert_content_key(key)
         case key
         when :subpage_target then :subpageTarget
+        when :livecrawl_timeout then :livecrawlTimeout
+        when :max_age_hours then :maxAgeHours
         else
           key
         end
@@ -79,6 +87,12 @@ module Exa
           else
             value
           end
+        when :highlights
+          if value.is_a?(Hash)
+            convert_hash_value(value, highlights_hash_mappings)
+          else
+            value
+          end
         else
           value
         end
@@ -96,7 +110,9 @@ module Exa
       def text_hash_mappings
         {
           max_characters: :maxCharacters,
-          include_html_tags: :includeHtmlTags
+          include_html_tags: :includeHtmlTags,
+          include_sections: :includeSections,
+          exclude_sections: :excludeSections
         }
       end
 
@@ -118,6 +134,15 @@ module Exa
           image_links: :imageLinks
         }
       end
+
+      def highlights_hash_mappings
+        {
+          max_characters: :maxCharacters,
+          num_sentences: :numSentences,
+          highlights_per_url: :highlightsPerUrl,
+          query: :query
+        }
+      end
     end
   end
 end

data/lib/exa/services/search.rb

@@ -5,7 +5,7 @@ require_relative "parameter_converter"
 module Exa
   module Services
     class Search
-      VALID_SEARCH_TYPES = ["fast", "deep", "keyword", "auto"].freeze
+      VALID_SEARCH_TYPES = ["auto", "neural", "fast", "deep", "deep-reasoning", "instant"].freeze
       DEFAULT_SEARCH_TYPE = "auto"
 
       def initialize(connection, **params)
@@ -24,7 +24,8 @@ module Exa
           resolved_search_type: body["resolvedSearchType"],
           search_type: body["searchType"],
           context: body["context"],
-          cost_dollars: body["costDollars"]
+          cost_dollars: body["costDollars"],
+          output: body["output"]
         )
       end
 

data/lib/exa/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Exa
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exa-ai
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Benjamin Jackson