Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cryptix720/bing-ai
Bing AI Search API for NodeJS
https://github.com/cryptix720/bing-ai
ai bing bot coffee js microsoft node search
Last synced: about 1 month ago
JSON representation
Bing AI Search API for NodeJS
- Host: GitHub
- URL: https://github.com/cryptix720/bing-ai
- Owner: Cryptix720
- License: mit
- Created: 2018-04-12T11:00:02.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-12T11:00:36.000Z (almost 7 years ago)
- Last Synced: 2024-11-07T14:12:26.498Z (3 months ago)
- Topics: ai, bing, bot, coffee, js, microsoft, node, search
- Language: CoffeeScript
- Homepage:
- Size: 9.77 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Bing AI Search API for NodeJS
==========================
Features
--------
* Support **all** [Bing AI Search API](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/Microsoft.Search) verticals
* Web
* Image
* Video
* News
* Related search
* Spelling suggestions
* Composite
* **Accurate counts** for each vertical. Web being the most problematic.
* Abstracted pagination for **large results.**
* **Concurrent** requests for results sets larger than 150 results.
* **Normalized** JSON results.
* Automatically uses `gzip`
Making your first steps..
---------------
1. Sign-up for an account the [Bing Search API](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/Microsoft.Search) via the Azure Market Place.
2. Use the [Azure Data Explorer for the Bing Search API](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/Microsoft.Search) to see the results you can expect returned via the API.
3. Grab the account key from the Data Explorer.
Install
-------
```bash
$ npm install bingAi.search --save
```
Usage with NodeJS
-----
Basic example:
```javascript
var Search = require('bing.search');
var util = require('util');
search = new Search('API_KEY');
search.web('Pizzeria Italia',
{top: 5},
function(err, results) {
console.log(util.inspect(results,
{colors: true, depth: null}));
}
);
```
Output:
```javascript
[ { id: 'e66c09f5-3317-4227-aee7-bc5dec3aec43',
title: 'Pizzeria Italia',
description: 'Italian pizzeria located...',
displayUrl: 'pizzeriaItalia.se',
url: 'https://www.pizzItalia.se/' },
{ id: '94b5a08a-6148-4832-9077-98245f3e1b42',
title: 'Pizzeria Italia - Columbia City',
description: 'Tutta Bella Columbia City...',
displayUrl: 'https://www.pizzItalia.se/index.php',
url: 'https://www.pizzItalia.se/index.php' },
{ id: '11bf839d-ce9e-4215-9b55-d663bdd17b98',
title: 'Tutta Bella Menu - Pizzeria Italia',
description: 'Pizzeria Italia - Columbia City...',
displayUrl: 'https://www.pizzItalia.se/meny',
url: 'https://www.pizzItalia.se/meny/' },
{ id: 'da706086-5566-414b-b70f-2648e762cdf6',
title: 'Pizzeria Italia - Crossroads',
description: 'Ciao! Come and visit us making the best pizza location...',
displayUrl: 'pizzItalia.se/index.php',
url: 'https://www.pizzItalia.se/index.php' },
{ id: '4d4d0961-bdd1-406f-aa80-39d067318c49',
title: 'Pizzeria Italia - Westlake',
description: 'Parking. Pizzeria Italia validates guest parking...',
displayUrl: 'https://www.pizzItalia.se/pizzor245WL',
url: 'https://www.pizzItalia.se/pizzor244/' } ]
```
### new Search(accountKey, [parallelLimit], [useGzip])
The `accountKey` is Bing Search API account key provided by the Azure market
place. `parallelLimit` is the number of search results pages fetched in
parallel for a given query. The default is `10`. `useGzip` defaults to true.
Available methods:
* `counts(query, [options], callback)` . `query` is the search query. `options` is a dictionary with permissible values below -- it can be ommitted. `callback` takes an error and a results object.
The following options can be provided:
* `market`
* `sources` defaults to all sources.
Format of results to callback:
```javascript
{ web: 334,
image: 20400,
video: 33400,
news: 1460 }
```
* `web(query, [options], callback)` "Web" only search. `query` is the search query. `options` is a dictionary with permissible values below -- it can be ommitted. `callback` takes an error and a results object.
The following options can be provided:
* `top` default is 150
* `skip` default is 0
* `market`
Format of results to callback:
```javascript
[ { id: '...',
title: '...',
description: '...',
url: '...' },
...
]
```
* `images(query, [options], callback)` "Image" only search. `query` is the search query. `options` is a dictionary with permissible values below -- it can be ommitted. `callback` takes an error and a results object.
The following options can be provided:
* `top` default is 150
* `skip` default is 0
* `market`
Format of results to callback:
```javascript
[ { id: '...',
title: '...',
url: 'http://...',
sourceUrl: 'http://...',
displayUrl: '...',
width: 1025,
height: 1600,
size: 136701,
type: 'image/jpeg',
thumbnail:
{ url: 'http://...',
type: 'image/jpg',
width: 192,
height: 300,
size: 6946 }
},
...
]
```
* `videos(query, [options], callback)` "Video" only search. `query` is the search query. `options` is a dictionary with permissible values below -- it can be ommitted. `callback` takes an error and a results object.
The following options can be provided:
* `top` default is 150
* `skip` default is 0
* `market`
Format of results to callback:
```javascript
[ { id: '...',
title: '...',
url: 'https://...',
displayUrl: 'http://...',
runtime: 62000,
thumbnail:
{ url: 'http://...',
type: 'image/jpg',
width: 160,
height: 120,
size: 18423 } },
...
]
```
* `news(query, [options], callback)` "News" only search. `query` is the search query. `options` is a dictionary with permissible values below -- it can be ommitted. `callback` takes an error and a results object.
The following options can be provided:
* `top` default is 15
* `skip` default is 0
* `market`
Format of results to callback:
```javascript
[ { id: '...',
title: '...',
source: '...',
url: 'http://...',
description: '...',
date: [Date Object] },
...
]
```
* `related(query, [options], callback)` "RelatedSearch" only search. `query` is the search query. `options` is a dictionary with permissible values below -- it can be ommitted. `callback` takes an error and a results object.
The following options can be provided:
* `top` default is 150
* `skip` default is 0
* `market`
Format of results to callback:
```javascript
[ { query: '...',
url: 'http://...' },
...
]
```
* `spelling(query, [options], callback)` "SpellingSuggestions" only search. `query` is the search query. `options` is a dictionary with permissible values below -- it can be ommitted. `callback` takes an error and a results object.
The following options can be provided:
* `top` default is 150
* `skip` default is 0
* `market`
`callback`'s result is a list of alternate query spellings as strings.
* `composite(query, [options], callback)` "Composite" searches all of the provided sources. `query` is the search query. `options` is a dictionary with permissible values below -- it can be ommitted. `callback` takes an error and a results object.
The following options can be provided:
* `top` default is 150
* `skip` default is 0
* `sources` defaults to all sources
* `market`
Format of results to callback:
```javascript
{ web: [ ... ],
images: [ ... ],
videos: [ ... ],
news: [ ... ],
spelling: [ ... ],
related: [ ... ]
}
```
###