exa-ai 0.12.2 → 0.14.0
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.
- checksums.yaml +4 -4
- data/README.md +120 -83
- data/exe/exa-ai +45 -152
- data/exe/exa-ai-agent-run-create +55 -20
- data/exe/exa-ai-agent-run-delete +1 -8
- data/exe/exa-ai-agent-run-events +21 -1
- data/exe/exa-ai-agent-run-list +1 -1
- data/exe/{exa-ai-research-list → exa-ai-agent-run-stop} +31 -32
- data/exe/exa-ai-answer +25 -0
- data/exe/exa-ai-context +6 -2
- data/exe/exa-ai-find-similar +26 -68
- data/exe/exa-ai-get-contents +138 -42
- data/exe/exa-ai-search +27 -104
- data/exe/exa-ai-search-monitor-batch +93 -0
- data/exe/exa-ai-search-monitor-create +104 -0
- data/exe/exa-ai-search-monitor-delete +69 -0
- data/exe/exa-ai-search-monitor-get +69 -0
- data/exe/exa-ai-search-monitor-list +73 -0
- data/exe/exa-ai-search-monitor-runs-get +68 -0
- data/exe/exa-ai-search-monitor-runs-list +75 -0
- data/exe/exa-ai-search-monitor-trigger +69 -0
- data/exe/exa-ai-search-monitor-update +102 -0
- data/lib/exa/cli/base.rb +57 -0
- data/lib/exa/cli/contents_flags.rb +199 -0
- data/lib/exa/cli/formatters/agent_run_formatter.rb +79 -3
- data/lib/exa/cli/formatters/search_formatter.rb +18 -2
- data/lib/exa/cli/formatters/search_monitor_formatter.rb +98 -0
- data/lib/exa/cli/search_parser.rb +46 -87
- data/lib/exa/client.rb +183 -333
- data/lib/exa/middleware/raise_error.rb +14 -0
- data/lib/exa/resources/agent_run.rb +5 -3
- data/lib/exa/resources/agent_run_deletion.rb +17 -0
- data/lib/exa/resources/answer.rb +3 -3
- data/lib/exa/resources/contents_result.rb +5 -1
- data/lib/exa/resources/find_similar_result.rb +5 -1
- data/lib/exa/resources/search_monitor.rb +42 -0
- data/lib/exa/resources/search_monitor_batch_result.rb +11 -0
- data/lib/exa/resources/{research_list.rb → search_monitor_list.rb} +3 -2
- data/lib/exa/resources/search_monitor_run.rb +46 -0
- data/lib/exa/resources/search_monitor_trigger_result.rb +11 -0
- data/lib/exa/resources/search_result.rb +11 -1
- data/lib/exa/services/agent_run_cancel.rb +1 -12
- data/lib/exa/services/agent_run_create.rb +1 -12
- data/lib/exa/services/agent_run_delete.rb +6 -14
- data/lib/exa/services/agent_run_events.rb +33 -4
- data/lib/exa/services/agent_run_get.rb +1 -12
- data/lib/exa/services/agent_run_list.rb +1 -12
- data/lib/exa/services/agent_run_stop.rb +21 -0
- data/lib/exa/services/agent_run_stream.rb +56 -52
- data/lib/exa/services/answer.rb +5 -2
- data/lib/exa/services/answer_stream.rb +57 -46
- data/lib/exa/services/context.rb +3 -1
- data/lib/exa/services/find_similar.rb +9 -2
- data/lib/exa/services/get_contents.rb +14 -15
- data/lib/exa/services/parameter_converter.rb +128 -111
- data/lib/exa/services/search.rb +58 -19
- data/lib/exa/services/search_monitors/batch.rb +36 -0
- data/lib/exa/services/search_monitors/create.rb +37 -0
- data/lib/exa/services/search_monitors/delete.rb +22 -0
- data/lib/exa/services/search_monitors/get.rb +22 -0
- data/lib/exa/services/search_monitors/list.rb +29 -0
- data/lib/exa/services/search_monitors/runs_get.rb +23 -0
- data/lib/exa/services/search_monitors/runs_list.rb +29 -0
- data/lib/exa/services/search_monitors/trigger.rb +22 -0
- data/lib/exa/services/search_monitors/update.rb +42 -0
- data/lib/exa/services/search_stream.rb +38 -0
- data/lib/exa/version.rb +1 -1
- data/lib/exa.rb +18 -56
- metadata +31 -94
- data/exe/exa-ai-enrichment-cancel +0 -108
- data/exe/exa-ai-enrichment-create +0 -226
- data/exe/exa-ai-enrichment-delete +0 -122
- data/exe/exa-ai-enrichment-get +0 -104
- data/exe/exa-ai-enrichment-list +0 -99
- data/exe/exa-ai-enrichment-update +0 -171
- data/exe/exa-ai-import-create +0 -253
- data/exe/exa-ai-import-delete +0 -92
- data/exe/exa-ai-import-get +0 -92
- data/exe/exa-ai-import-list +0 -72
- data/exe/exa-ai-import-update +0 -164
- data/exe/exa-ai-monitor-create +0 -223
- data/exe/exa-ai-monitor-delete +0 -101
- data/exe/exa-ai-monitor-get +0 -92
- data/exe/exa-ai-monitor-list +0 -90
- data/exe/exa-ai-monitor-runs-get +0 -103
- data/exe/exa-ai-monitor-runs-list +0 -110
- data/exe/exa-ai-monitor-update +0 -207
- data/exe/exa-ai-research-get +0 -109
- data/exe/exa-ai-research-start +0 -174
- data/exe/exa-ai-webset-cancel +0 -97
- data/exe/exa-ai-webset-create +0 -254
- data/exe/exa-ai-webset-delete +0 -111
- data/exe/exa-ai-webset-get +0 -93
- data/exe/exa-ai-webset-item-delete +0 -111
- data/exe/exa-ai-webset-item-get +0 -105
- data/exe/exa-ai-webset-item-list +0 -108
- data/exe/exa-ai-webset-list +0 -91
- data/exe/exa-ai-webset-search-cancel +0 -104
- data/exe/exa-ai-webset-search-create +0 -247
- data/exe/exa-ai-webset-search-get +0 -105
- data/exe/exa-ai-webset-update +0 -143
- data/lib/exa/cli/formatters/enrichment_formatter.rb +0 -125
- data/lib/exa/cli/formatters/import_formatter.rb +0 -153
- data/lib/exa/cli/formatters/monitor_formatter.rb +0 -144
- data/lib/exa/cli/formatters/monitor_run_formatter.rb +0 -126
- data/lib/exa/cli/formatters/research_formatter.rb +0 -124
- data/lib/exa/cli/formatters/webset_formatter.rb +0 -134
- data/lib/exa/cli/formatters/webset_item_formatter.rb +0 -131
- data/lib/exa/cli/formatters/webset_search_formatter.rb +0 -57
- data/lib/exa/constants/websets.rb +0 -19
- data/lib/exa/resources/import.rb +0 -86
- data/lib/exa/resources/import_collection.rb +0 -33
- data/lib/exa/resources/monitor.rb +0 -48
- data/lib/exa/resources/monitor_collection.rb +0 -30
- data/lib/exa/resources/monitor_run.rb +0 -52
- data/lib/exa/resources/monitor_run_collection.rb +0 -30
- data/lib/exa/resources/research_task.rb +0 -39
- data/lib/exa/resources/webset.rb +0 -74
- data/lib/exa/resources/webset_collection.rb +0 -33
- data/lib/exa/resources/webset_enrichment.rb +0 -71
- data/lib/exa/resources/webset_enrichment_collection.rb +0 -28
- data/lib/exa/resources/webset_item_collection.rb +0 -33
- data/lib/exa/resources/webset_search.rb +0 -112
- data/lib/exa/services/research_get.rb +0 -30
- data/lib/exa/services/research_list.rb +0 -37
- data/lib/exa/services/research_start.rb +0 -26
- data/lib/exa/services/websets/cancel.rb +0 -36
- data/lib/exa/services/websets/cancel_enrichment.rb +0 -35
- data/lib/exa/services/websets/cancel_search.rb +0 -44
- data/lib/exa/services/websets/create.rb +0 -45
- data/lib/exa/services/websets/create_enrichment.rb +0 -35
- data/lib/exa/services/websets/create_search.rb +0 -48
- data/lib/exa/services/websets/create_search_validator.rb +0 -128
- data/lib/exa/services/websets/create_validator.rb +0 -213
- data/lib/exa/services/websets/delete.rb +0 -36
- data/lib/exa/services/websets/delete_enrichment.rb +0 -35
- data/lib/exa/services/websets/delete_item.rb +0 -20
- data/lib/exa/services/websets/get_item.rb +0 -20
- data/lib/exa/services/websets/get_search.rb +0 -43
- data/lib/exa/services/websets/import_create.rb +0 -40
- data/lib/exa/services/websets/import_delete.rb +0 -37
- data/lib/exa/services/websets/import_get.rb +0 -37
- data/lib/exa/services/websets/import_list.rb +0 -25
- data/lib/exa/services/websets/import_update.rb +0 -38
- data/lib/exa/services/websets/import_upload.rb +0 -58
- data/lib/exa/services/websets/list.rb +0 -25
- data/lib/exa/services/websets/list_items.rb +0 -26
- data/lib/exa/services/websets/monitors/create.rb +0 -42
- data/lib/exa/services/websets/monitors/delete.rb +0 -32
- data/lib/exa/services/websets/monitors/get.rb +0 -33
- data/lib/exa/services/websets/monitors/list.rb +0 -27
- data/lib/exa/services/websets/monitors/runs/get.rb +0 -37
- data/lib/exa/services/websets/monitors/runs/list.rb +0 -30
- data/lib/exa/services/websets/monitors/update.rb +0 -33
- data/lib/exa/services/websets/retrieve.rb +0 -47
- data/lib/exa/services/websets/retrieve_enrichment.rb +0 -35
- data/lib/exa/services/websets/update.rb +0 -37
- data/lib/exa/services/websets/update_enrichment.rb +0 -36
- data/lib/exa/services/websets_parameter_converter.rb +0 -45
data/lib/exa/services/search.rb
CHANGED
|
@@ -5,8 +5,48 @@ require_relative "parameter_converter"
|
|
|
5
5
|
module Exa
|
|
6
6
|
module Services
|
|
7
7
|
class Search
|
|
8
|
-
VALID_SEARCH_TYPES = ["auto", "neural", "fast", "deep", "deep-reasoning", "instant"].freeze
|
|
8
|
+
VALID_SEARCH_TYPES = ["auto", "lite", "deep-lite", "neural", "fast", "deep", "deep-reasoning", "instant"].freeze
|
|
9
9
|
DEFAULT_SEARCH_TYPE = "auto"
|
|
10
|
+
DYNAMIC_HIGHLIGHTS_BETA = "dynamic-highlights-2026-08-28"
|
|
11
|
+
BETA_HIGHLIGHTS_KEYS = %w[dynamic verbosity].freeze
|
|
12
|
+
|
|
13
|
+
# Returns the Exa-Beta header that a converted request body needs, or an
|
|
14
|
+
# empty hash. The API rejects highlights.dynamic and highlights.verbosity
|
|
15
|
+
# without it. Highlights sit under contents on /search and /findSimilar
|
|
16
|
+
# and at the top level on /contents, so both places are checked.
|
|
17
|
+
def self.beta_headers(body)
|
|
18
|
+
contents = body[:contents] || body["contents"]
|
|
19
|
+
highlights = contents[:highlights] || contents["highlights"] if contents.is_a?(Hash)
|
|
20
|
+
highlights ||= body[:highlights] || body["highlights"]
|
|
21
|
+
return {} unless highlights.is_a?(Hash)
|
|
22
|
+
return {} unless highlights.keys.any? { |key| BETA_HIGHLIGHTS_KEYS.include?(key.to_s) }
|
|
23
|
+
|
|
24
|
+
{ "Exa-Beta" => DYNAMIC_HIGHLIGHTS_BETA }
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Raises ArgumentError unless search_type is one of VALID_SEARCH_TYPES.
|
|
28
|
+
def self.validate_search_type!(search_type)
|
|
29
|
+
return if VALID_SEARCH_TYPES.include?(search_type)
|
|
30
|
+
|
|
31
|
+
raise ArgumentError, "Invalid search type: '#{search_type}'. Must be one of: #{VALID_SEARCH_TYPES.join(', ')}"
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# Parses each result whose summary is a String of JSON into a Hash. The
|
|
35
|
+
# API returns a summary as JSON text when the request gave a schema.
|
|
36
|
+
# A summary that is not valid JSON, an empty one included, is kept as
|
|
37
|
+
# received, so one bad summary does not lose the other results.
|
|
38
|
+
# GetContents uses it too.
|
|
39
|
+
def self.parse_json_summaries(results)
|
|
40
|
+
results&.map do |r|
|
|
41
|
+
next r unless r["summary"].is_a?(String)
|
|
42
|
+
|
|
43
|
+
begin
|
|
44
|
+
r.merge("summary" => JSON.parse(r["summary"]))
|
|
45
|
+
rescue JSON::ParserError
|
|
46
|
+
r
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
end
|
|
10
50
|
|
|
11
51
|
def initialize(connection, **params)
|
|
12
52
|
@connection = connection
|
|
@@ -15,11 +55,14 @@ module Exa
|
|
|
15
55
|
end
|
|
16
56
|
|
|
17
57
|
def call
|
|
18
|
-
|
|
58
|
+
request_body = ParameterConverter.convert(@params)
|
|
59
|
+
response = @connection.post("/search", request_body) do |request|
|
|
60
|
+
request.headers.update(self.class.beta_headers(request_body))
|
|
61
|
+
end
|
|
19
62
|
body = response.body
|
|
20
63
|
|
|
21
64
|
results = body["results"]
|
|
22
|
-
results = parse_json_summaries(results) if summary_schema?
|
|
65
|
+
results = self.class.parse_json_summaries(results) if summary_schema?(request_body)
|
|
23
66
|
|
|
24
67
|
Resources::SearchResult.new(
|
|
25
68
|
results: results,
|
|
@@ -28,7 +71,10 @@ module Exa
|
|
|
28
71
|
search_type: body["searchType"],
|
|
29
72
|
context: body["context"],
|
|
30
73
|
cost_dollars: body["costDollars"],
|
|
31
|
-
output: body["output"]
|
|
74
|
+
output: body["output"],
|
|
75
|
+
warnings: body["warnings"],
|
|
76
|
+
notices: body["notices"],
|
|
77
|
+
search_time: body["searchTime"]
|
|
32
78
|
)
|
|
33
79
|
end
|
|
34
80
|
|
|
@@ -42,24 +88,17 @@ module Exa
|
|
|
42
88
|
end
|
|
43
89
|
|
|
44
90
|
def validate_search_type!
|
|
45
|
-
|
|
46
|
-
return if VALID_SEARCH_TYPES.include?(search_type)
|
|
47
|
-
|
|
48
|
-
raise ArgumentError, "Invalid search type: '#{search_type}'. Must be one of: #{VALID_SEARCH_TYPES.join(', ')}"
|
|
91
|
+
self.class.validate_search_type!(@params[:type])
|
|
49
92
|
end
|
|
50
93
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
94
|
+
# True when the request asked for JSON summaries. Reads the converted
|
|
95
|
+
# body, so a flat summary_schema: and a caller's contents: {summary:
|
|
96
|
+
# {schema:}} count as well as summary: {schema:}.
|
|
97
|
+
def summary_schema?(request_body)
|
|
98
|
+
contents = request_body[:contents]
|
|
99
|
+
return false unless contents.is_a?(Hash)
|
|
54
100
|
|
|
55
|
-
|
|
56
|
-
results&.map do |r|
|
|
57
|
-
if r["summary"].is_a?(String)
|
|
58
|
-
r.merge("summary" => JSON.parse(r["summary"]))
|
|
59
|
-
else
|
|
60
|
-
r
|
|
61
|
-
end
|
|
62
|
-
end
|
|
101
|
+
contents[:summary].is_a?(Hash) && contents[:summary][:schema]
|
|
63
102
|
end
|
|
64
103
|
end
|
|
65
104
|
end
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "../../resources/search_monitor_batch_result"
|
|
4
|
+
|
|
5
|
+
module Exa
|
|
6
|
+
module Services
|
|
7
|
+
module SearchMonitors
|
|
8
|
+
# POST /monitors/batch — delete, pause or unpause every monitor that matches a filter.
|
|
9
|
+
# The API uses snake_case keys here, so the body is built by hand and never converted.
|
|
10
|
+
# It is a dry run unless the caller passes dry_run: false.
|
|
11
|
+
class Batch
|
|
12
|
+
def initialize(connection, action:, filter:, dry_run: true, limit: nil)
|
|
13
|
+
@connection = connection
|
|
14
|
+
@action = action
|
|
15
|
+
@filter = filter
|
|
16
|
+
@dry_run = dry_run
|
|
17
|
+
@limit = limit
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
def call
|
|
21
|
+
body = { action: @action, filter: @filter, dry_run: @dry_run != false }
|
|
22
|
+
body[:limit] = @limit if @limit
|
|
23
|
+
|
|
24
|
+
result = @connection.post("/monitors/batch", body).body
|
|
25
|
+
Resources::SearchMonitorBatchResult.new(
|
|
26
|
+
action: result["action"],
|
|
27
|
+
affected: result["affected"],
|
|
28
|
+
ids: result["ids"],
|
|
29
|
+
dry_run: result["dry_run"],
|
|
30
|
+
has_more: result["has_more"]
|
|
31
|
+
)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "../parameter_converter"
|
|
4
|
+
require_relative "../../resources/search_monitor"
|
|
5
|
+
|
|
6
|
+
module Exa
|
|
7
|
+
module Services
|
|
8
|
+
module SearchMonitors
|
|
9
|
+
# POST /monitors — create a scheduled search that posts results to a webhook.
|
|
10
|
+
class Create
|
|
11
|
+
def initialize(connection, search:, webhook:, **params)
|
|
12
|
+
@connection = connection
|
|
13
|
+
@params = params.merge(search: search, webhook: webhook)
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
def call
|
|
17
|
+
response = @connection.post("/monitors", request_body)
|
|
18
|
+
Resources::SearchMonitor.from_response(response.body)
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
private
|
|
22
|
+
|
|
23
|
+
# Only the search hash and the top-level output_schema key change case.
|
|
24
|
+
# Values of metadata and output_schema go to the API as given.
|
|
25
|
+
def request_body
|
|
26
|
+
@params.each_with_object({}) do |(key, value), body|
|
|
27
|
+
case key
|
|
28
|
+
when :search then body[:search] = ParameterConverter.convert(value)
|
|
29
|
+
when :output_schema then body[:outputSchema] = value
|
|
30
|
+
else body[key] = value
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "../../resources/search_monitor"
|
|
4
|
+
|
|
5
|
+
module Exa
|
|
6
|
+
module Services
|
|
7
|
+
module SearchMonitors
|
|
8
|
+
# DELETE /monitors/{id} — returns the deleted monitor.
|
|
9
|
+
class Delete
|
|
10
|
+
def initialize(connection, id:)
|
|
11
|
+
@connection = connection
|
|
12
|
+
@id = id
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
def call
|
|
16
|
+
response = @connection.delete("/monitors/#{@id}")
|
|
17
|
+
Resources::SearchMonitor.from_response(response.body)
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "../../resources/search_monitor"
|
|
4
|
+
|
|
5
|
+
module Exa
|
|
6
|
+
module Services
|
|
7
|
+
module SearchMonitors
|
|
8
|
+
# GET /monitors/{id}
|
|
9
|
+
class Get
|
|
10
|
+
def initialize(connection, id:)
|
|
11
|
+
@connection = connection
|
|
12
|
+
@id = id
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
def call
|
|
16
|
+
response = @connection.get("/monitors/#{@id}")
|
|
17
|
+
Resources::SearchMonitor.from_response(response.body)
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "../../resources/search_monitor"
|
|
4
|
+
require_relative "../../resources/search_monitor_list"
|
|
5
|
+
|
|
6
|
+
module Exa
|
|
7
|
+
module Services
|
|
8
|
+
module SearchMonitors
|
|
9
|
+
# GET /monitors — list search monitors. Takes status, name, cursor, limit,
|
|
10
|
+
# and metadata (a hash, sent as metadata[key]=value).
|
|
11
|
+
class List
|
|
12
|
+
def initialize(connection, **params)
|
|
13
|
+
@connection = connection
|
|
14
|
+
@params = params
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
def call
|
|
18
|
+
body = @connection.get("/monitors", @params).body
|
|
19
|
+
|
|
20
|
+
Resources::SearchMonitorList.new(
|
|
21
|
+
data: body["data"].map { |monitor| Resources::SearchMonitor.from_response(monitor) },
|
|
22
|
+
has_more: body["hasMore"],
|
|
23
|
+
next_cursor: body["nextCursor"]
|
|
24
|
+
)
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "../../resources/search_monitor_run"
|
|
4
|
+
|
|
5
|
+
module Exa
|
|
6
|
+
module Services
|
|
7
|
+
module SearchMonitors
|
|
8
|
+
# GET /monitors/{id}/runs/{runId}
|
|
9
|
+
class RunsGet
|
|
10
|
+
def initialize(connection, monitor_id:, run_id:)
|
|
11
|
+
@connection = connection
|
|
12
|
+
@monitor_id = monitor_id
|
|
13
|
+
@run_id = run_id
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
def call
|
|
17
|
+
response = @connection.get("/monitors/#{@monitor_id}/runs/#{@run_id}")
|
|
18
|
+
Resources::SearchMonitorRun.from_response(response.body)
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "../../resources/search_monitor_run"
|
|
4
|
+
require_relative "../../resources/search_monitor_list"
|
|
5
|
+
|
|
6
|
+
module Exa
|
|
7
|
+
module Services
|
|
8
|
+
module SearchMonitors
|
|
9
|
+
# GET /monitors/{id}/runs — list the runs of one search monitor.
|
|
10
|
+
class RunsList
|
|
11
|
+
def initialize(connection, monitor_id:, **params)
|
|
12
|
+
@connection = connection
|
|
13
|
+
@monitor_id = monitor_id
|
|
14
|
+
@params = params
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
def call
|
|
18
|
+
body = @connection.get("/monitors/#{@monitor_id}/runs", @params).body
|
|
19
|
+
|
|
20
|
+
Resources::SearchMonitorList.new(
|
|
21
|
+
data: body["data"].map { |run| Resources::SearchMonitorRun.from_response(run) },
|
|
22
|
+
has_more: body["hasMore"],
|
|
23
|
+
next_cursor: body["nextCursor"]
|
|
24
|
+
)
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "../../resources/search_monitor_trigger_result"
|
|
4
|
+
|
|
5
|
+
module Exa
|
|
6
|
+
module Services
|
|
7
|
+
module SearchMonitors
|
|
8
|
+
# POST /monitors/{id}/trigger — run the monitor now (status active or paused).
|
|
9
|
+
class Trigger
|
|
10
|
+
def initialize(connection, id:)
|
|
11
|
+
@connection = connection
|
|
12
|
+
@id = id
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
def call
|
|
16
|
+
response = @connection.post("/monitors/#{@id}/trigger")
|
|
17
|
+
Resources::SearchMonitorTriggerResult.new(triggered: response.body["triggered"])
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "../parameter_converter"
|
|
4
|
+
require_relative "../../resources/search_monitor"
|
|
5
|
+
|
|
6
|
+
module Exa
|
|
7
|
+
module Services
|
|
8
|
+
module SearchMonitors
|
|
9
|
+
# PATCH /monitors/{id} — change part of a search monitor.
|
|
10
|
+
# nil is sent as null only for the keys the API accepts as null (name, trigger,
|
|
11
|
+
# metadata); trigger: nil removes the schedule. Other keys with nil are left out.
|
|
12
|
+
class Update
|
|
13
|
+
NULLABLE_KEYS = %i[name trigger metadata].freeze
|
|
14
|
+
|
|
15
|
+
def initialize(connection, id:, **params)
|
|
16
|
+
@connection = connection
|
|
17
|
+
@id = id
|
|
18
|
+
@params = params
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
def call
|
|
22
|
+
response = @connection.patch("/monitors/#{@id}", request_body)
|
|
23
|
+
Resources::SearchMonitor.from_response(response.body)
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
private
|
|
27
|
+
|
|
28
|
+
def request_body
|
|
29
|
+
@params.each_with_object({}) do |(key, value), body|
|
|
30
|
+
next if value.nil? && !NULLABLE_KEYS.include?(key)
|
|
31
|
+
|
|
32
|
+
case key
|
|
33
|
+
when :search then body[:search] = ParameterConverter.convert(value)
|
|
34
|
+
when :output_schema then body[:outputSchema] = value
|
|
35
|
+
else body[key] = value
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "answer_stream"
|
|
4
|
+
require_relative "search"
|
|
5
|
+
|
|
6
|
+
module Exa
|
|
7
|
+
module Services
|
|
8
|
+
# Streams a /search request as server-sent events. The API streams only
|
|
9
|
+
# when outputSchema is set, so this class requires output_schema. Each
|
|
10
|
+
# chunk is yielded as a Hash with a "type" of text-delta, grounding,
|
|
11
|
+
# results, stream-reset or done; an error chunk raises Exa::Error.
|
|
12
|
+
class SearchStream < AnswerStream
|
|
13
|
+
# Checks output_schema and the search type, then converts the params
|
|
14
|
+
# into the /search request body with stream set to true.
|
|
15
|
+
def initialize(connection, **params)
|
|
16
|
+
raise ArgumentError, "output_schema is required for search streaming" unless params[:output_schema]
|
|
17
|
+
|
|
18
|
+
params = { type: Search::DEFAULT_SEARCH_TYPE }.merge(params)
|
|
19
|
+
Search.validate_search_type!(params[:type])
|
|
20
|
+
|
|
21
|
+
@connection = connection
|
|
22
|
+
@params = ParameterConverter.convert(params.merge(stream: true))
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
private
|
|
26
|
+
|
|
27
|
+
# Streams post to /search instead of /answer.
|
|
28
|
+
def path
|
|
29
|
+
"/search"
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Sends the Exa-Beta header when the body asks for dynamic highlights.
|
|
33
|
+
def headers
|
|
34
|
+
Search.beta_headers(@params)
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
data/lib/exa/version.rb
CHANGED
data/lib/exa.rb
CHANGED
|
@@ -4,94 +4,56 @@ require "dotenv/load"
|
|
|
4
4
|
|
|
5
5
|
require_relative "exa/version"
|
|
6
6
|
require_relative "exa/error"
|
|
7
|
-
require_relative "exa/constants/websets"
|
|
8
7
|
require_relative "exa/middleware/raise_error"
|
|
9
8
|
require_relative "exa/connection"
|
|
10
9
|
require_relative "exa/resources/search_result"
|
|
11
10
|
require_relative "exa/resources/find_similar_result"
|
|
12
11
|
require_relative "exa/resources/contents_result"
|
|
13
|
-
require_relative "exa/resources/research_task"
|
|
14
|
-
require_relative "exa/resources/research_list"
|
|
15
12
|
require_relative "exa/resources/agent_run"
|
|
13
|
+
require_relative "exa/resources/agent_run_deletion"
|
|
16
14
|
require_relative "exa/resources/agent_run_list"
|
|
17
15
|
require_relative "exa/resources/agent_run_event_list"
|
|
16
|
+
require_relative "exa/resources/search_monitor"
|
|
17
|
+
require_relative "exa/resources/search_monitor_list"
|
|
18
|
+
require_relative "exa/resources/search_monitor_run"
|
|
19
|
+
require_relative "exa/resources/search_monitor_batch_result"
|
|
20
|
+
require_relative "exa/resources/search_monitor_trigger_result"
|
|
18
21
|
require_relative "exa/resources/answer"
|
|
19
22
|
require_relative "exa/resources/context_result"
|
|
20
|
-
require_relative "exa/resources/webset_collection"
|
|
21
|
-
require_relative "exa/resources/webset"
|
|
22
|
-
require_relative "exa/resources/webset_search"
|
|
23
|
-
require_relative "exa/resources/webset_enrichment"
|
|
24
|
-
require_relative "exa/resources/webset_enrichment_collection"
|
|
25
|
-
require_relative "exa/resources/webset_item_collection"
|
|
26
|
-
require_relative "exa/resources/import"
|
|
27
|
-
require_relative "exa/resources/import_collection"
|
|
28
|
-
require_relative "exa/resources/monitor"
|
|
29
|
-
require_relative "exa/resources/monitor_collection"
|
|
30
|
-
require_relative "exa/resources/monitor_run"
|
|
31
|
-
require_relative "exa/resources/monitor_run_collection"
|
|
32
23
|
require_relative "exa/services/search"
|
|
33
24
|
require_relative "exa/services/find_similar"
|
|
34
25
|
require_relative "exa/services/get_contents"
|
|
35
|
-
require_relative "exa/services/research_get"
|
|
36
|
-
require_relative "exa/services/research_start"
|
|
37
|
-
require_relative "exa/services/research_list"
|
|
38
26
|
require_relative "exa/services/agent_run_create"
|
|
39
27
|
require_relative "exa/services/agent_run_stream"
|
|
40
28
|
require_relative "exa/services/agent_run_get"
|
|
41
29
|
require_relative "exa/services/agent_run_list"
|
|
42
30
|
require_relative "exa/services/agent_run_cancel"
|
|
31
|
+
require_relative "exa/services/agent_run_stop"
|
|
43
32
|
require_relative "exa/services/agent_run_delete"
|
|
44
33
|
require_relative "exa/services/agent_run_events"
|
|
34
|
+
require_relative "exa/services/search_monitors/create"
|
|
35
|
+
require_relative "exa/services/search_monitors/list"
|
|
36
|
+
require_relative "exa/services/search_monitors/get"
|
|
37
|
+
require_relative "exa/services/search_monitors/update"
|
|
38
|
+
require_relative "exa/services/search_monitors/delete"
|
|
39
|
+
require_relative "exa/services/search_monitors/trigger"
|
|
40
|
+
require_relative "exa/services/search_monitors/batch"
|
|
41
|
+
require_relative "exa/services/search_monitors/runs_list"
|
|
42
|
+
require_relative "exa/services/search_monitors/runs_get"
|
|
45
43
|
require_relative "exa/services/answer"
|
|
46
44
|
require_relative "exa/services/answer_stream"
|
|
45
|
+
require_relative "exa/services/search_stream"
|
|
47
46
|
require_relative "exa/services/context"
|
|
48
|
-
require_relative "exa/services/websets/list"
|
|
49
|
-
require_relative "exa/services/websets/retrieve"
|
|
50
|
-
require_relative "exa/services/websets/delete"
|
|
51
|
-
require_relative "exa/services/websets/cancel"
|
|
52
|
-
require_relative "exa/services/websets/update"
|
|
53
|
-
require_relative "exa/services/websets/create"
|
|
54
|
-
require_relative "exa/services/websets/create_search"
|
|
55
|
-
require_relative "exa/services/websets/get_search"
|
|
56
|
-
require_relative "exa/services/websets/cancel_search"
|
|
57
|
-
require_relative "exa/services/websets/create_enrichment"
|
|
58
|
-
require_relative "exa/services/websets/retrieve_enrichment"
|
|
59
|
-
require_relative "exa/services/websets/update_enrichment"
|
|
60
|
-
require_relative "exa/services/websets/delete_enrichment"
|
|
61
|
-
require_relative "exa/services/websets/cancel_enrichment"
|
|
62
|
-
require_relative "exa/services/websets/get_item"
|
|
63
|
-
require_relative "exa/services/websets/delete_item"
|
|
64
|
-
require_relative "exa/services/websets/list_items"
|
|
65
|
-
require_relative "exa/services/websets/import_create"
|
|
66
|
-
require_relative "exa/services/websets/import_upload"
|
|
67
|
-
require_relative "exa/services/websets/import_list"
|
|
68
|
-
require_relative "exa/services/websets/import_get"
|
|
69
|
-
require_relative "exa/services/websets/import_update"
|
|
70
|
-
require_relative "exa/services/websets/import_delete"
|
|
71
|
-
require_relative "exa/services/websets/monitors/create"
|
|
72
|
-
require_relative "exa/services/websets/monitors/list"
|
|
73
|
-
require_relative "exa/services/websets/monitors/get"
|
|
74
|
-
require_relative "exa/services/websets/monitors/update"
|
|
75
|
-
require_relative "exa/services/websets/monitors/delete"
|
|
76
|
-
require_relative "exa/services/websets/monitors/runs/list"
|
|
77
|
-
require_relative "exa/services/websets/monitors/runs/get"
|
|
78
47
|
require_relative "exa/client"
|
|
79
48
|
require_relative "exa/cli/base"
|
|
80
49
|
require_relative "exa/cli/polling"
|
|
81
50
|
require_relative "exa/cli/error_handler"
|
|
82
51
|
require_relative "exa/cli/formatters/search_formatter"
|
|
83
|
-
require_relative "exa/cli/formatters/webset_search_formatter"
|
|
84
52
|
require_relative "exa/cli/formatters/context_formatter"
|
|
85
53
|
require_relative "exa/cli/formatters/contents_formatter"
|
|
86
|
-
require_relative "exa/cli/formatters/research_formatter"
|
|
87
54
|
require_relative "exa/cli/formatters/agent_run_formatter"
|
|
55
|
+
require_relative "exa/cli/formatters/search_monitor_formatter"
|
|
88
56
|
require_relative "exa/cli/formatters/answer_formatter"
|
|
89
|
-
require_relative "exa/cli/formatters/webset_formatter"
|
|
90
|
-
require_relative "exa/cli/formatters/webset_item_formatter"
|
|
91
|
-
require_relative "exa/cli/formatters/enrichment_formatter"
|
|
92
|
-
require_relative "exa/cli/formatters/import_formatter"
|
|
93
|
-
require_relative "exa/cli/formatters/monitor_formatter"
|
|
94
|
-
require_relative "exa/cli/formatters/monitor_run_formatter"
|
|
95
57
|
|
|
96
58
|
module Exa
|
|
97
59
|
# Module-level configuration
|