dylang / what-dog

Get the breed of a dog from an image using Microsoft's what-dog

what-dog

Get the breed of a dog from an image using Microsoft's what-dog.

{
  "isDog": true,
  "breed": "Norfolk Terrier",
  "about": "Spirited, small but sturdy, feisty yet sweet personality"
}

Install

$ npm install --save what-dog

Usage

const whatDog = require('what-dog');

whatDot('http://imgur.com/B7a15F5.jpg');
    .then(doggyData => {
        console.log(doggyData);
    })

//=> {
       isDog: true,
       breed: 'Norfolk Terrier',
       about: 'Spirited, small but sturdy, feisty yet sweet personality'
     }

API

whatDot(imageUrl)

imageUrl

Type: string

Url to the image. Must be on a public server that Microsoft's servers can download to determine the caption.

Returns a promise for the doggy data.

doggy data

{
  isDog: true,
  breed: 'Norfolk Terrier',
  about: 'Spirited, small but sturdy, feisty yet sweet personality'
}

Notes

• Requires Node 4 or newer.
• Powered by What-Dog, a free service provided by Microsoft.
• If you like this, you can read more at https://www.microsoft.com/cognitive-services.
• This node module was not created by Microsoft.
• I would consider this module "for testing only" - I do not recommend using in a production system.
• Microsoft: I made this because I am a fan of the technology. If there are any problems, or you want to use this package name, I'm happy to discuss.

License

MIT © Dylan Greene

what-dog's Issues

Feature: add ability to send local files

How did you figure out how to post to their API?
I don't see any docs on this sort of thing anywhere, i.e. the domain or the query params.

    return got.post('https://www.what-dog.net/Home/Analyze', {
        query: {
            isTest: 'False',
            version: '001',
            faceUrl: imageUrl,
            faceName: imageUrl
        }

I want to be able to send pictures from my local drive.

-

Completely ignore this. I am using your library (thank you very much for providing it) and accidentally opened an issue against your repo instead of mine...

HTTP 301 (Moved Permanently) Error

what-dog.net is no longer the valid website and redirects to https://www.bing.com/visualsearch/Microsoft/WhatDog although the api error has no Location parameter.
Although changing the home URL to that in the code doesn't work.
I'm unsure how the API end points work, possible fix maybe?
Wanted to implement this in a Discord bot.

Fix docs typo

Just noticed a small typo in the code example:

whatDot('http://imgur.com/B7a15F5.jpg');
    .then(doggyData => {
        console.log(doggyData);
    })

should be

whatDog('http://imgur.com/B7a15F5.jpg')
    .then(doggyData => {
        console.log(doggyData);
    })

Also saw another whatDot and doggy data instead of whatDog and doggyData in the API section.