pliers.converters.MicrosoftAPITextConverter

class pliers.converters.MicrosoftAPITextConverter(language='en', subscription_key=None, location=None, api_version='v1.0', rate_limit=None)

Bases: MicrosoftVisionAPITransformer, ImageToTextConverter

Detects text within images using the Microsoft Vision API.

Parameters

• language (str) – Target language to detect in the image.

• subscription_key (str) – A valid subscription key for Microsoft Cognitive Services. Only needs to be passed the first time the extractor is initialized.

• location (str) – Region the subscription key has been registered in. It will be the first part of the endpoint URL suggested by Microsoft when you first created the key. Examples include: westus, westcentralus, eastus

• api_version (str) – API version to use.

• rate_limit (int) – The minimum number of seconds required between transform calls on this Transformer.

__init__(language='en', subscription_key=None, location=None, api_version='v1.0', rate_limit=None)

transform(stims, validation='strict', *args, **kwargs)

Executes the transformation on the passed stim(s).

Parameters

• stims (str, Stim, list) –

  One or more stimuli to process. Must be one of:

  • A string giving the path to a file that can be read in as a Stim (e.g., a .txt file, .jpg image, etc.)

  • A Stim instance of any type.

  • An iterable of stims, where each element is either a string or a Stim.

• validation (str) –

  String specifying how validation errors should be handled. Must be one of:

  • ’strict’: Raise an exception on any validation error

  • ’warn’: Issue a warning for all validation errors

  • ’loose’: Silently ignore all validation errors

• args – Optional positional arguments to pass onto the internal _transform call.

• kwargs – Optional positional arguments to pass onto the internal _transform call.