Module: Exa

Defined in:
lib/exa.rb,
lib/exa/error.rb,
lib/exa/client.rb,
lib/exa/version.rb,
lib/exa/cli/base.rb,
lib/exa/connection.rb,
lib/exa/cli/polling.rb,
lib/exa/services/answer.rb,
lib/exa/services/search.rb,
lib/exa/resources/answer.rb,
lib/exa/resources/import.rb,
lib/exa/resources/webset.rb,
lib/exa/services/context.rb,
lib/exa/cli/error_handler.rb,
lib/exa/cli/search_parser.rb,
lib/exa/constants/websets.rb,
lib/exa/resources/monitor.rb,
lib/exa/resources/monitor_run.rb,
lib/exa/services/find_similar.rb,
lib/exa/services/get_contents.rb,
lib/exa/services/research_get.rb,
lib/exa/services/websets/list.rb,
lib/exa/middleware/raise_error.rb,
lib/exa/services/answer_stream.rb,
lib/exa/services/research_list.rb,
lib/exa/resources/research_list.rb,
lib/exa/resources/research_task.rb,
lib/exa/resources/search_result.rb,
lib/exa/resources/webset_search.rb,
lib/exa/services/research_start.rb,
lib/exa/services/websets/cancel.rb,
lib/exa/services/websets/create.rb,
lib/exa/services/websets/delete.rb,
lib/exa/services/websets/update.rb,
lib/exa/resources/context_result.rb,
lib/exa/resources/contents_result.rb,
lib/exa/services/websets/get_item.rb,
lib/exa/services/websets/retrieve.rb,
lib/exa/resources/import_collection.rb,
lib/exa/resources/webset_collection.rb,
lib/exa/resources/webset_enrichment.rb,
lib/exa/services/websets/get_search.rb,
lib/exa/services/websets/import_get.rb,
lib/exa/services/websets/list_items.rb,
lib/exa/resources/monitor_collection.rb,
lib/exa/services/parameter_converter.rb,
lib/exa/services/websets/delete_item.rb,
lib/exa/services/websets/import_list.rb,
lib/exa/resources/find_similar_result.rb,
lib/exa/services/websets/monitors/get.rb,
lib/exa/services/websets/cancel_search.rb,
lib/exa/services/websets/create_search.rb,
lib/exa/services/websets/import_create.rb,
lib/exa/services/websets/import_delete.rb,
lib/exa/services/websets/import_update.rb,
lib/exa/services/websets/import_upload.rb,
lib/exa/services/websets/monitors/list.rb,
lib/exa/cli/formatters/answer_formatter.rb,
lib/exa/cli/formatters/import_formatter.rb,
lib/exa/cli/formatters/search_formatter.rb,
lib/exa/cli/formatters/webset_formatter.rb,
lib/exa/cli/formatters/context_formatter.rb,
lib/exa/cli/formatters/monitor_formatter.rb,
lib/exa/resources/monitor_run_collection.rb,
lib/exa/resources/webset_item_collection.rb,
lib/exa/services/websets/monitors/create.rb,
lib/exa/services/websets/monitors/delete.rb,
lib/exa/services/websets/monitors/update.rb,
lib/exa/cli/formatters/contents_formatter.rb,
lib/exa/cli/formatters/research_formatter.rb,
lib/exa/services/websets/create_validator.rb,
lib/exa/services/websets/cancel_enrichment.rb,
lib/exa/services/websets/create_enrichment.rb,
lib/exa/services/websets/delete_enrichment.rb,
lib/exa/services/websets/monitors/runs/get.rb,
lib/exa/services/websets/update_enrichment.rb,
lib/exa/cli/formatters/enrichment_formatter.rb,
lib/exa/services/websets/monitors/runs/list.rb,
lib/exa/cli/formatters/monitor_run_formatter.rb,
lib/exa/cli/formatters/webset_item_formatter.rb,
lib/exa/services/websets/retrieve_enrichment.rb,
lib/exa/services/websets_parameter_converter.rb,
lib/exa/cli/formatters/webset_search_formatter.rb,
lib/exa/resources/webset_enrichment_collection.rb,
lib/exa/services/websets/create_search_validator.rb

Defined Under Namespace

Modules: CLI, Constants, Middleware, Resources, Services Classes: BadGateway, BadRequest, Client, ClientError, ConfigurationError, Connection, Error, Forbidden, GatewayTimeout, InternalServerError, NotFound, PaymentRequired, ServerError, ServiceUnavailable, TooManyRequests, Unauthorized, UnprocessableEntity

Constant Summary collapse

DEFAULT_BASE_URL =

Constants for default values

"https://api.exa.ai"
DEFAULT_TIMEOUT = 
30
VERSION = 
"0.11.2"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_key ⇒ Object

Returns the value of attribute api_key.



88
89
90
 
# File 'lib/exa.rb', line 88

def api_key
  @api_key
end

.base_url ⇒ Object

Returns the value of attribute base_url.



88
89
90
 
# File 'lib/exa.rb', line 88

def base_url
  @base_url
end

.timeout ⇒ Object

Returns the value of attribute timeout.



88
89
90
 
# File 'lib/exa.rb', line 88

def timeout
  @timeout
end

Class Method Details

.configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:

  • _self (Exa) —

    the object that the method was called on



90
91
92
 
# File 'lib/exa.rb', line 90

def configure
  yield self
end

.reset ⇒ Object 



94
95
96
97
98
 
# File 'lib/exa.rb', line 94

def reset
  self.api_key = nil
  self.base_url = DEFAULT_BASE_URL
  self.timeout = DEFAULT_TIMEOUT
end