module mokadi.cognitive_services_helper

Short summary

module botadi.mokadi.cognitive_services_helper

Call to Cognitive Services.

source on GitHub

Functions

function

truncated documentation

bytes2python

Converts JSON bytes into a dictionary.

call_api_emotions

Retrieves resuls for the emotions API.

call_api_images

Retrieves resuls for the image API.

call_api_news

Retrieves resuls for the news API.

call_api_speech_reco

Implemented in module ensae_teaching_cs. …

Documentation

@file @brief Call to Cognitive Services.

botadi.mokadi.cognitive_services_helper.bytes2python(answer)

Converts JSON bytes into a dictionary.

@param answer bytes @return any type

botadi.mokadi.cognitive_services_helper.call_api_emotions(subkey, image_or_bytes)

Retrieves resuls for the emotions API.

@param subkey subscription key @param image_or_bytes image or bytes @return results

botadi.mokadi.cognitive_services_helper.call_api_images(subscription_key, query, market='fr-FR', count=10, offset=0)

Retrieves resuls for the image API.

@param subscription_key @param query query @param market market @param count number of results @param offset skip results @return results

Example of a result:

{'_type': 'News',
 'readLink': 'https://api.cognitive.microsoft.com/api/v5/news/search?q=',
 'value': [{'name': "Colombie : le bilan de la coulée de boue s'alourdit 54 morts",
            'url': 'http://www.bing.com/cr?IG=CEFF9C63FD7A4439B591261606484860&CID=3B75F5FD9A146DBF103CFFA49BF36C83&rd=1&',
            'image': {'thumbnail': {'contentUrl': 'https://www.bing.com/th?id=ON.08357B50C029DBC09D053826F9B22658&pid=News',
                                    'width': 700, 'height': 304}},
            'description': "Selon les d꤬arations du président colombien ...., le bilan de la gigantesque coulée de ",
            'provider': [{'_type': 'Organization', 'name': 'Le Point'}],
            'datePublished': '2017-04-03T10:33:00',
            'headline': True,
            'clusteredArticles': [{'name': "Colombie : le bilan s'alourdit de 54 orts, dont 43 enfants",
                                   'url': 'http://www.bing.com/cr?I.....',
                                   'description': "La ville de Mocoa, capitale ..., a été frappée ces derniers ...",
                                   'provider': [{'_type': 'Organization', 'name': 'Le Figaro'}],
                                   'datePublished': '2017-04-03T09:38:00', 'headline': True},
...
botadi.mokadi.cognitive_services_helper.call_api_news(subscription_key, query, market='fr-FR', count=10, offset=0)

Retrieves resuls for the news API.

@param subscription_key @param query query @param market market @param count number of results @param offset skip results @return results

Example of a result:

{
  "_type": "Images",
  "instrumentation": {},
  "readLink": "https://api.cognitive.microsoft.com/api/v7/images/search?q=puppies",
  "webSearchUrl": "https://www.bing.com/images/search?q=puppies&FORM=OIIARP",
  "totalEstimatedMatches": 955,
  "nextOffset": 1,
  "value": [
    {
      "webSearchUrl": "https://www.bing.com/images/search?view=detailv2&FORM=...",
      "name": "So cute - Puppies Wallpaper (14749028) - Fanpop",
      "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OIP.jHrihoDNkXGS1t5e89jNfwEsDh&pid=Api",
      "datePublished": "2014-02-01T21:55:00.0000000Z",
      "contentUrl": "http://images4.fanpop.com/image/photos/14700000/So-cute-puppies-14749028-1600-1200.jpg",
      "hostPageUrl": "http://www.fanpop.com/clubs/puppies/images/14749028/title/cute-wallpaper",
      "contentSize": "394455 B",
      "encodingFormat": "jpeg",
      "hostPageDisplayUrl": "www.fanpop.com/clubs/puppies/images/14749028/title/cute-wallpaper",
      "width": 1600,
      "height": 1200,
      "thumbnail": {
        "width": 300,
        "height": 225
      },
      "imageInsightsToken": "ccid_jHrihoDN*mid_F68CC526226E163FD1EA659747...",
      "insightsMetadata": {
        "recipeSourcesCount": 0
      },
      "imageId": "F68CC526226E163FD1EA659747ADCB8F9FA3CD96",
      "accentColor": "8D613E"
    }
  ],
  "queryExpansions": [
    {
      "text": "Shih Tzu Puppies",
      "displayText": "Shih Tzu",
      "webSearchUrl": "https://www.bing.com/images/search?q=Shih+Tzu+Puppies&tq=%7b%22pq...",
      "searchLink": "https://api.cognitive.microsoft.com/api/v7/images/search?q=S22%2c%...",
      "thumbnail": {
        "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Shih+Tzu+Puppies&pid=Api&mkt=en-US&adlt=moderate&t=1"
      }
    }
  ],
  ...
botadi.mokadi.cognitive_services_helper.call_api_speech_reco(subkey, lang='fr-FR', filename=None, memwav=None, url='https://speech.platform.bing.com/recognize')

Implemented in module ensae_teaching_cs. Only available on Windows for the time being (relies on C# code).

@param subkey subscription key @param lang language @param filename wav file @param memwav wav memory stream @param url url of the service @return dictionary wih the results

Either filename or memwav must be specified.