StArE.js (Node.js Server version)

!npm
!npm
!NPM

Description

StArE.js is an open source project intended to facilitate developers the creation of alternative visualizations of search engine results page (SERP). StArE.js provides a modular and extensible processing pipeline capable of (1) transforming SERP, (2) extracting features from individual search results, and (3) visualizing SERP in multiple ways.

Installation

``bash
npm i @stare.js/stare.js-server
`


How to use

`js
const stare = require('@stare.js/stare.js-server')({...options});

stare('google', 'What is love?', 10, ['ranking', 'language'])
.then(result => {
console.log(result);
})
.catch(err => {
console.error(err);
});
`

Where the arguments of the funtction are:

| Argument | Type | Description |
| ----- | ----- | ----- |
| engine | String | Search Engine to use (requires previous configuration for some cases) |
| query |String | Search Query (self explanatory)
| number of results to show | Number | Maximun numbers of documents/results to get from the engine |
| metrics | Array | Metrics to get from each document |

You can find the most basic full example in the examples folder.

Resources

* npm package
* Documentation
* Examples

Extensions

StArE.js is currently extended with the following plugins:

$3

| SERP | Function name | Description | Documentation |
| ------ | ------ | ------ | ------ |
| Google | google | Handler for SERPs obtained through the Google Custom Search JSON API | See docs |
| Bing | bing | Handler for SERPs obtained through the Bing web search API | See docs |
| Ecosia | ecosia | Handler for SERPs obtained from ecosia through a web scrapper | See docs |
| ElasticSearch | elasticsearch | Handler for SERPs obtained from ElasticSearch (only basic support) via request-promise | See docs |
| Solr | solr | Handler for SERPs obtained from Solr (only basic support) via request-promise | See docs |
| AWS Search Cloud | searchcloud | Handler for SERPs obtained from AWS Search Cloud (only basic support) via request-promise | See docs |

| Metrics | Metric name | Description | Documentation |
| ------ | ------ | ------ | ------ |
| Perspicuity | perspicuity | Reading Ease for English and Perspicuity for Spanish | See docs |
| Language | language | Detect the most probable language for a document | See docs |
| Length of Documents | length | Calculate the length in characters of a Document | See docs |
| Ranking | ranking | Calculate the length in characters of a Document | See docs |
| Keywords Position | keywords-position | Gets the position of the query terms (keywords) inside the text body of the document | See docs |
| Links | links | Gets the relation between the documents based on the url that the text body contains. Only for HTML documents. | See docs |
| Multimedia | multimedia | Gets the amount of multimedia data on the document (audio, video, images) that the text body contains. Only for HTML documents. | See docs |

As is explained in the docs you can create your own extensions for SERP and metrics support.

Please read the full documentation here.

Debug / Logging

StArE.js is powered by debug.
In order to see all the debug output, run your app with the environment variable
DEBUG including the desired scope.

To see the output from all of StArE.js's debugging scopes you can use:

`
DEBUG=stare.js
``

Contributors

- Roberto González-Ibáñez
- Camila Márquez
- Daniel Gacitúa
- Franz Farbinger
- Diego Salazar S.

License

MIT