Nachos Pillage Milwaukee

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

    3.0.1 • Public • Published

    An isomorphic javascript sdk for - EntitySearchClient

    This package contains an isomorphic SDK for EntitySearchClient.

    Currently supported environments

    • Node.js version 6.x.x or higher
    • Browser JavaScript

    How to Install

    npm install @azure/cognitiveservices-entitysearch

    How to use

    nodejs - Authentication, client creation and search entities as an example written in TypeScript.

    Install @azure/ms-rest-azure-js
    npm install @azure/ms-rest-azure-js
    Sample code

    The following sample performs a Bing entity search on the query 'Microsoft Azure'. To know more, refer to the Azure Documentation on Bing Entities Search.

    const { EntitySearchClient } = require("@azure/cognitiveservices-entitysearch");
    const { CognitiveServicesCredentials } = require("@azure/ms-rest-azure-js");
    
    async function main() {
      const entitySearchKey = process.env["entitySearchKey"] || "<entitySearchKey>";
      const entitySearchEndPoint =
        process.env["entitySearchEndPoint"] || "<entitySearchEndPoint>";
      const cognitiveServiceCredentials = new CognitiveServicesCredentials(
        entitySearchKey
      );
      const client = new EntitySearchClient(cognitiveServiceCredentials, {
        endpoint: entitySearchEndPoint
      });
      const query = "Microsoft Azure";
      client.entities
        .search(query)
        .then(result => {
          console.log("The result is: ");
          console.log(result);
        })
        .catch(err => {
          console.log("An error occurred:");
          console.error(err);
        });
    }
    
    main();

    browser - Authentication, client creation and search entities as an example written in JavaScript.

    Sample code
    • index.html
    <!DOCTYPE html>
    <html lang="en">
      <head>
        <title>@azure/cognitiveservices-entitysearch sample</title>
        <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
        <script src="node_modules/@azure/cognitiveservices-entitysearch/dist/cognitiveservices-entitysearch.js"></script>
        <script type="text/javascript">
          const entitySearchKey = "<YOUR_ENTITY_SEARCH_KEY>";
          const entitySearchEndPoint = "<YOUR_ENTITY_SEARCH_ENDPOINT>";
          const cognitiveServiceCredentials = new msRest.ApiKeyCredentials({
            inHeader: {
              "Ocp-Apim-Subscription-Key": entitySearchKey
            }
          });
          const client = new Azure.CognitiveservicesEntitysearch.EntitySearchClient(
            cognitiveServiceCredentials,
            {
              endpoint: entitySearchEndPoint
            }
          );
    
          const query = "Microsoft Azure";
          client.entities
            .search(query)
            .then(result => {
              console.log("The result is: ");
              console.log(result);
            })
            .catch(err => {
              console.log("An error occurred:");
              console.error(err);
            });
        </script>
      </head>
      <body></body>
    </html>

    Related projects

    Impressions

    Install

    npm i @azure/cognitiveservices-entitysearch

    DownloadsWeekly Downloads

    46

    Version

    3.0.1

    License

    MIT

    Unpacked Size

    612 kB

    Total Files

    49

    Last publish

    Collaborators

    • amarzavery
    • vladbarosan
    • veronicagg
    • azure-sdk