Detect Face

Detect facial attributes in the image

Arguments

Argument Type Default value Description
image_file str Nonefilepath of image file
image_url str NoneURI to image, if given will be used instead of image_file
face_attributes str Nonecomma separated list of attributes, for example. "age,gender,smile"
face_landmarks bool Falsereturn face landmarks of the detected faces or not. The default value is False
recognition_model str recognition_02model used by Azure to detech faces, options are "recognition_01" or "recognition_02", default is "recognition_02"
json_file str Nonefilepath to write results into
param image_file:
 filepath of image file
param image_url:
 URI to image, if given will be used instead of image_file
param face_attributes:
 comma separated list of attributes, for example. "age,gender,smile"
param face_landmarks:
 return face landmarks of the detected faces or not. The default value is False
param recognition_model:
 model used by Azure to detech faces, options are "recognition_01" or "recognition_02", default is "recognition_02"
param json_file:
 filepath to write results into
return:analysis in json format

Read more about face_attributes at Face detection explained:

  • age
  • gender
  • smile
  • facialHair
  • headPose
  • glasses
  • emotion
  • hair
  • makeup
  • accessories
  • blur
  • exposure
  • nouse

Detect Language

Detect languages in the given text

Arguments

Argument Type Default value Description
text strA UTF-8 text string
json_file str Nonefilepath to write results into
param text:A UTF-8 text string
param json_file:
 filepath to write results into
return:analysis in json format

Find Entities

Detect entities in the given text

Arguments

Argument Type Default value Description
text strA UTF-8 text string
language str Noneif input language is known
json_fileNonefilepath to write results into
param text:A UTF-8 text string
param language:if input language is known
param json_file:
 filepath to write results into
return:analysis in json format

Init Computer Vision Service

Initialize Azure Computer Vision

Arguments

Argument Type Default value Description
region str Noneidentifier for service region
use_robocloud_vault bool Falseuse secret stored into Robocloud Vault
param region:identifier for service region
param use_robocloud_vault:
 use secret stored into Robocloud Vault

Init Face Service

Initialize Azure Face

Arguments

Argument Type Default value Description
region str Noneidentifier for service region
use_robocloud_vault bool Falseuse secret stored into Robocloud Vault
param region:identifier for service region
param use_robocloud_vault:
 use secret stored into Robocloud Vault

Init Speech Service

Initialize Azure Speech

Arguments

Argument Type Default value Description
region str Noneidentifier for service region
use_robocloud_vault bool Falseuse secret stored into Robocloud Vault
param region:identifier for service region
param use_robocloud_vault:
 use secret stored into Robocloud Vault

Init Text Analytics Service

Initialize Azure Text Analyticts

Arguments

Argument Type Default value Description
region str Noneidentifier for service region
use_robocloud_vault bool Falseuse secret stored into Robocloud Vault
param region:identifier for service region
param use_robocloud_vault:
 use secret stored into Robocloud Vault

Key Phrases

Detect key phrases in the given text

Arguments

Argument Type Default value Description
text strA UTF-8 text string
language str Noneif input language is known
json_file str Nonefilepath to write results into
param text:A UTF-8 text string
param language:if input language is known
param json_file:
 filepath to write results into
return:analysis in json format

List Supported Voices

List supported voices for Azure API Speech Services.

Arguments

Argument Type Default value Description
locale str Nonelist only voices specific to locale, by default return all voices
neural_only bool FalseTrue if only neural voices should be returned, False by default
json_file str Nonefilepath to write results into
param locale:list only voices specific to locale, by default return all voices
param neural_only:
 True if only neural voices should be returned, False by default
param json_file:
 filepath to write results into
return:voices in json

Available voice selection might differ between regions.

Sentiment Analyze

Analyze sentiments in the given text

Arguments

Argument Type Default value Description
text strA UTF-8 text string
language str Noneif input language is known
json_file str Nonefilepath to write results into
param text:A UTF-8 text string
param language:if input language is known
param json_file:
 filepath to write results into
return:analysis in json format

Set Robocloud Vault

Set Robocloud Vault name

Arguments

Argument Type Default value Description
vault_nameRobocloud Vault name
param vault_name:
 Robocloud Vault name

Text To Speech

Synthesize speech synchronously

Arguments

Argument Type Default value Description
text strinput text to synthesize
language str en-USvoice language, defaults to "en-US"
name str en-US-AriaRUSvoice name, defaults to "en-US-AriaRUS"
gender str FEMALEvoice gender, defaults to "FEMALE"
encoding str MP3result encoding type, defaults to "MP3"
neural_voice_style typing.Any Noneif given then neural voice is used, example style. "cheerful"
target_file str synthesized.mp3save synthesized output to file, defaults to "synthesized.mp3"
param text:input text to synthesize
param language:voice language, defaults to "en-US"
param name:voice name, defaults to "en-US-AriaRUS"
param gender:voice gender, defaults to "FEMALE"
param encoding:result encoding type, defaults to "MP3"
param neural_voice_style:
 if given then neural voice is used, example style. "cheerful"
param target_file:
 save synthesized output to file, defaults to "synthesized.mp3"
return:synthesized output in bytes

Neural voices are only supported for Speech resources created in East US, South East Asia, and West Europe regions.

Vision Analyze

Identify features in the image

Arguments

Argument Type Default value Description
image_file str Nonefilepath of image file
image_url str NoneURI to image, if given will be used instead of image_file
visual_features str Nonecomma separated list of features, for example. "Categories,Description,Color"
json_file str Nonefilepath to write results into
param image_file:
 filepath of image file
param image_url:
 URI to image, if given will be used instead of image_file
param visual_features:
 comma separated list of features, for example. "Categories,Description,Color"
param json_file:
 filepath to write results into
return:analysis in json format

See Computer Vision API for valid feature names and their explanations:

  • Adult
  • Brands
  • Categories
  • Color
  • Description
  • Faces
  • ImageType
  • Objects
  • Tags

Vision Describe

Describe image with tags and captions

Arguments

Argument Type Default value Description
image_file str Nonefilepath of image file
image_url str NoneURI to image, if given will be used instead of image_file
json_file str Nonefilepath to write results into
param image_file:
 filepath of image file
param image_url:
 URI to image, if given will be used instead of image_file
param json_file:
 filepath to write results into
return:analysis in json format

Vision Detect Objects

Detect objects in the image

Arguments

Argument Type Default value Description
image_file str Nonefilepath of image file
image_url str NoneURI to image, if given will be used instead of image_file
json_file str Nonefilepath to write results into
param image_file:
 filepath of image file
param image_url:
 URI to image, if given will be used instead of image_file
param json_file:
 filepath to write results into
return:analysis in json format

Vision Ocr

Optical Character Recognition (OCR) detects text in an image

Arguments

Argument Type Default value Description
image_file str Nonefilepath of image file
image_url str NoneURI to image, if given will be used instead of image_file
json_file str Nonefilepath to write results into
param image_file:
 filepath of image file
param image_url:
 URI to image, if given will be used instead of image_file
param json_file:
 filepath to write results into
return:analysis in json format