This package has been deprecated

Author message:

This package is deprecated in favor of @azure/cognitiveservices-entitysearch which works both on node.js and browsers

azure-cognitiveservices-entitysearch
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

Microsoft Azure SDK for Node.js - Cognitive Services Entity Search

This project provides a Node.js package that makes it easy to work with Microsoft Azure Cognitive Services Entity Search API. Right now it supports:

  • Node.js version: 6.x or higher

How to Install

npm install azure-cognitiveservices-entitysearch

How to use

Create a Cognitive Services Bing Search Account

  const msRestAzure = require('ms-rest-azure');
  const CognitiveServicesManagement = require("azure-arm-cognitiveservices");
  let client;
  let createAccount = msRestAzure.interactiveLogin().then((credentials) => {
    client = new CognitiveServicesManagement(credentials, suite.subscriptionId);
    return client.accounts.create('groupname', 'accountname', {
      sku: {
        name: "S1"
      },
      kind: "Bing.Search",
      location: "westus",
      properties: {}
    });
  }).catch((err) => {
    console.log('An error ocurred');
    console.dir(err, {depth: null, colors: true});
  });

List the keys from the created account

  let serviceKey;
  createAccount.then((result) => {
    return client.accounts.listKeys('groupname', 'accountname');
  }).then((result) => {
    serviceKey = result.key1;
    console.log(result.key2);
  }).catch((err) => {
    console.log('An error ocurred');
    console.dir(err, {depth: null, colors: true});
  });

Create credentials

const CognitiveServicesCredentials = require('ms-rest-azure').CognitiveServicesCredentials;
let credentials = new CognitiveServicesCredentials(serviceKey);

Query the Entity Search API

const EntitySearchAPIClient = require('azure-cognitiveservices-entitysearch');
 
let entitySearchApiClient = new EntitySearchAPIClient(credentials);
 
entitySearchApiClient.entitiesOperations.search('seahawks').then((result) => {
 console.log(result.queryContext);
 console.log(result.entities.value);
 console.log(result.entities.value[0].description);
}).catch((err) => {
 throw err;
});

More Detailed Information

https://azure.microsoft.com/en-us/try/cognitive-services/ under "Search"

Related Projects

Readme

Keywords

Package Sidebar

Install

npm i azure-cognitiveservices-entitysearch

Weekly Downloads

5

Version

2.0.0

License

MIT

Unpacked Size

267 kB

Total Files

48

Last publish

Collaborators

  • windowsazure