Results

Results Model

Attributes

publication_match[R]

Array of EBSCO::EDS::Record Exact Publication Matches.

records[R]

Array of EBSCO::EDS::Record results.

research_starters[R]

Array of EBSCO::EDS::Record Research Starters.

results[R]

Raw search results as a hash.

Methods

---

applied_expanders()

Expanders applied to the search.

[
   {"Id"=>"fulltext", "RemoveAction"=>"removeexpander(fulltext)"},
   {"Id"=>"thesaurus", "RemoveAction"=>"removeexpander(thesaurus)"},
   {"Id"=>"relatedsubjects", "RemoveAction"=>"removeexpander(relatedsubjects)"}
 ]

applied_facets()

List of facets applied to the search.

[{
   "FacetValue"=>{"Id"=>"SubjectGeographic", "Value"=>"massachusetts"},
   "RemoveAction"=>"removefacetfiltervalue(1,SubjectGeographic:massachusetts)"
 }]

applied_limiters()

List of limiters applied to the search.

[{
   "Id"=>"LA99",
   "LimiterValuesWithAction"=>[{"Value"=>"French", "RemoveAction"=>"removelimitervalue(LA99:French)"}],
   "RemoveAction"=>"removelimiter(LA99)"
}]

applied_publications()

Publications search was limited to.

[
   ["Id", "eric"],
   ["RemoveAction", "removepublication(eric)"]
]

database_stats()

Provides a list of databases searched and the number of hits found in each one.

[
   {:id=>"nlebk", :hits=>0, :label=>"eBook Collection (EBSCOhost)"},
   {:id=>"e000xna", :hits=>30833, :label=>"eBook Academic Collection (EBSCOhost)"},
   {:id=>"edsart", :hits=>8246, :label=>"ARTstor Digital Library"},
   {:id=>"e700xna", :hits=>6701, :label=>"eBook Public Library Collection (EBSCOhost)"},
   {:id=>"cat02060a", :hits=>3464, :label=>"EDS Demo Catalog – US - U of Georgia"},
   {:id=>"ers", :hits=>1329, :label=>"Research Starters"},
   {:id=>"asn", :hits=>136406, :label=>"Academic Search Ultimate"}
 ]

date_range()

Returns a hash of the date range available for the search.

{:mindate=>"1501-01", :maxdate=>"2018-04", :minyear=>"1501", :maxyear=>"2018"}

did_you_mean()

Provides alternative search terms to correct spelling, etc.

results = session.simple_search('earthquak')
results.did_you_mean
=> "earthquake"

facets(facet_provided_id = 'all')

Provides a list of facets for the search results.

[
   {
     :id=>"SourceType",
     :label=>"Source Type",
     :values=>[
       {
          :value=>"Academic Journals",
          :hitcount=>147,
          :action=>"addfacetfilter(SourceType:Academic Journals)"
       },
       {
          :value=>"News",
          :hitcount=>111,
          :action=>"addfacetfilter(SourceType:News)"
        },

    ...

   }
 ]

page_number()

Current page number for the results. Returns an integer.

retrieval_criteria()

Retrieval criteria that was applied to the search. Returns a hash.

{"View"=>"brief", "ResultsPerPage"=>20, "PageNumber"=>1, "Highlight"=>"y"}

search_criteria()

Search criteria used in the search Returns a hash.

{
   "Queries"=>[{"BooleanOperator"=>"AND", "Term"=>"earthquakes"}],
   "SearchMode"=>"all",
   "IncludeFacets"=>"y",
   "Expanders"=>["fulltext", "thesaurus", "relatedsubjects"],
   "Sort"=>"relevance",
   "RelatedContent"=>["rs"],
   "AutoSuggest"=>"n"
 }

search_criteria_with_actions()

Search criteria actions applied. Returns a hash.

{
   "QueriesWithAction"=>[{"Query"=>{"BooleanOperator"=>"AND", "Term"=>"earthquakes"}, "RemoveAction"=>"removequery(1)"}],
   "ExpandersWithAction"=>[{"Id"=>"fulltext", "RemoveAction"=>"removeexpander(fulltext)"}]
}

search_queries()

Queries used to produce the results. Returns an array of query hashes.

[{"BooleanOperator"=>"AND", "Term"=>"volcano"}]

search_terms()

Returns a simple list of the search terms used. Boolean operators are not indicated.

["earthquakes", "california"]

stat_total_hits()

Total number of results found.

stat_total_time()

Time it took to complete the search in milliseconds.