Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mycaule/knowledge-graph-js

An ES6 client for Google, DuckDuckGo, Wolfram knowledge services
https://github.com/mycaule/knowledge-graph-js

Last synced: 3 months ago
JSON representation

An ES6 client for Google, DuckDuckGo, Wolfram knowledge services

Host: GitHub
URL: https://github.com/mycaule/knowledge-graph-js
Owner: mycaule
License: apache-2.0
Created: 2017-12-06T12:51:21.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2018-03-22T16:29:22.000Z (almost 7 years ago)
Last Synced: 2024-10-07T17:48:20.793Z (3 months ago)
Language: JavaScript
Homepage:
Size: 92.8 KB
Stars: 13
Watchers: 4
Forks: 2
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


	





  Universal internet knowledge search client for Google, DuckDuckGo, Wolfram|Alpha





  

  

  

	


	

	

	

  


  




This library is a ES6 client to get internet knowledge information from various providers:

  - [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/),

  - [DuckDuckGo Instant Answer API](https://duckduckgo.com/api)

  - [Wolfram|Alpha Short Answers API](https://products.wolframalpha.com/short-answers-api/documentation/)

The library is tested out recurrently on a dataset using [ava](https://github.com/avajs/ava), [superstruct](https://github.com/ianstormtaylor/superstruct) and [Travis CI](http://travis-ci.org/mycaule/knowledge-graph-js).

##  Usage

In *Google Cloud Platform*, make sure to [activate *Knowledge Graph Search API*](https://developers.google.com/knowledge-graph/prereqs) and assign your *API key* to `process.env.GOOGLE_API_KEY`.

In *Wolfram|Alpha* developer portal, [create an application](https://developer.wolframalpha.com/portal/myapps/) and assign your *AppID* to `process.env.WOLFRAM_APP_ID`.

See [the samples folder](/samples) for more usecases.

### Running with Node.js

```javascript

const knowledge = require('knowledge-graph-js')

// Search using only a query

knowledge.search('katy perry')

// Search specifying the entity type

knowledge.search('Madison Square Garden', 'Place')

// List of available graph entities

knowledge.entities

```

#### Basic example

```bash

$ node samples/quickstart.js

```

```javascript

knowledge.search('katy perry').then(res => {

  console.log(res.top)

})

/*

{ '@id': 'kg:/m/03y82t6',

  name: 'Katy Perry',

  '@type': [ 'Person', 'Thing' ],

  description: 'American singer-songwriter',

  image:

   { contentUrl: 'http://t3.gstatic.com/images?q=tbn:ANd9GcQrlKFmaiEtUImNiuD_pqzHPjDcjF4yaRThSFMh-rYuB8snFUfk',

     url: 'https://en.wikipedia.org/wiki/Katy_Perry' },

  detailedDescription:

   { articleBody: 'Katheryn Elizabeth Hudson, known professionally as Katy Perry, is an American singer and songwriter. After singing in church during her childhood, she pursued a career in

gospel music as a teenager. ',

     url: 'https://en.wikipedia.org/wiki/Katy_Perry',

     license: 'https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License' },

  url: 'http://www.katyperry.com/' }

*/

```

#### Benchmarking results

```bash

$ node samples/benchmark.js

```

```javascript

const patriarchy = require('patriarchy')

knowledge.google.search('katy perry').then(res => {

  console.log(patriarchy(res.top))

})

knowledge.duckduckgo.search('katy perry').then(res => {

  console.log(patriarchy(res.top))

})

knowledge.wolfram.search('katy perry').then(res => {

  console.log(res)

})

```

#### Keywords extraction

```bash

$ node samples/keywords.js

```

```javascript

const natural = require('natural')

knowledge.search('nelson mandela').then(res => {

  const {description, detailedDescription} = res.top

  console.log(res.top)

  console.log(description)

  natural.PorterStemmer.attach()

  console.log(description.tokenizeAndStem())

  console.log(detailedDescription.articleBody.tokenizeAndStem())

})

/*

{ '@id': 'kg:/m/05g7q',

  name: 'Nelson Mandela',

  '@type': [ 'Person', 'Thing' ],

  description: 'Former President of South Africa',

  image:

   { contentUrl: 'http://t1.gstatic.com/images?q=tbn:ANd9GcTFuD6oHFEztHdeTZTBHMQK-HHe1WKUeTzT0blYtptSvVlaOvRc',

     url: 'https://commons.wikimedia.org/wiki/File:Nelson-Mandela-with-congressman-Engel.png' },

  detailedDescription:

   { articleBody: 'Nelson Rolihlahla Mandela was a South African anti-apartheid revolutionary, political leader, and philanthropist, who served as President of South Africa from 1994 to 1999

. ',

     url: 'https://en.wikipedia.org/wiki/Nelson_Mandela',

     license: 'https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License' },

  url: 'http://www.nelsonmandela.org/' }

[ 'former', 'presid', 'south', 'africa' ]

[ 'nelson', 'rolihlahla', 'mandela', 'south', 'african', 'anti', 'apartheid', 'revolutionari', 'polit', 'leader', 'philanthropist', 'serv', 'presid', 'south', 'africa', '1994', '1999' ]

*/

```

## Contributions

[Changes and improvements](https://github.com/mycaule/knowledge-graph-js/wiki) are welcome! Feel free to fork and open a pull request into `master`.

You can lint the code and run all unit tests using `npm test`.

### Roadmap

* Unit tests for errors (API responses, validation errors from superstruct) [returning-errors](https://github.com/ianstormtaylor/superstruct/blob/master/examples/returning-errors.js), [throwing-errors](https://github.com/ianstormtaylor/superstruct/blob/master/examples/throwing-errors.js), [custom-errors](https://github.com/ianstormtaylor/superstruct/blob/master/examples/custom-errors.js)

* Make the `README` clearer and write more code samples

### License

`knowledge-graph-js` is licensed under the [Apache 2.0 License](https://github.com/mycaule/knowledge-graph-js/blob/master/LICENSE).

## References

* [Knowledge Graph Search API documentation](https://developers.google.com/knowledge-graph/)

* [DuckDuckGo Instant Answer API](https://duckduckgo.com/api)

* [Wolfram|Alpha Short Answers API](https://products.wolframalpha.com/short-answers-api/documentation/)

* [Sofia Martins - knowledge-node package](https://www.npmjs.com/package/knowledge-node)

* [Luke Wendling - ddg-api package](https://github.com/lukewendling/ddg-api)

* [Nicole He - Voice Technology is an Opportunity to Make Weird Stuff](https://medium.com/@nicolehe/voice-technology-is-an-opportunity-to-make-weird-stuff-d4296ce7448a)