azure.cognitiveservices.vision.contentmoderator.models.ocr.yml

### YamlMime:PythonClass
uid: azure.cognitiveservices.vision.contentmoderator.models.OCR
name: OCR
fullName: azure.cognitiveservices.vision.contentmoderator.models.OCR
module: azure.cognitiveservices.vision.contentmoderator.models
inheritances:
- msrest.serialization.Model
summary: Contains the text found in image for the language specified.
constructor:
  syntax: 'OCR(*, status=None, metadata=None, tracking_id: str = None, cache_id: str
    = None, language: str = None, text: str = None, candidates=None, **kwargs)'
  parameters:
  - name: status
    description: The evaluate status
    isRequired: true
    types:
    - <xref:azure.cognitiveservices.vision.contentmoderator.models.Status>
  - name: metadata
    description: Array of KeyValue.
    isRequired: true
    types:
    - <xref:list>[<xref:azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair>]
  - name: tracking_id
    description: The tracking id.
    isRequired: true
    types:
    - <xref:str>
  - name: cache_id
    description: The cache id.
    isRequired: true
    types:
    - <xref:str>
  - name: language
    description: The ISO 639-3 code.
    isRequired: true
    types:
    - <xref:str>
  - name: text
    description: The found text.
    isRequired: true
    types:
    - <xref:str>
  - name: candidates
    description: The list of candidate text.
    isRequired: true
    types:
    - <xref:list>[<xref:azure.cognitiveservices.vision.contentmoderator.models.Candidate>]
  keywordOnlyParameters:
  - name: status
    isRequired: true
  - name: metadata
    isRequired: true
  - name: tracking_id
    isRequired: true
  - name: cache_id
    isRequired: true
  - name: language
    isRequired: true
  - name: text
    isRequired: true
  - name: candidates
    isRequired: true
methods:
- uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.as_dict
  name: as_dict
  summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\
    \ optionally use a callback as parameter:\n\nKey is the attribute name used in\
    \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\
    msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\
    \ in this object.\n\nThe string returned will be used to serialize the key.\n\
    If the return type is a list, this is considered hierarchical\nresult dict.\n\n\
    See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\
    \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\
    \ pass the kwargs is_xml=True."
  signature: as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>,
    **kwargs)
  parameters:
  - name: key_transformer
    description: A key transformer function.
    types:
    - <xref:function>
  - name: keep_readonly
    defaultValue: 'True'
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.deserialize
  name: deserialize
  summary: Parse a str using the RestAPI syntax and return a model.
  signature: deserialize(data, content_type=None)
  parameters:
  - name: data
    description: A str using RestAPI structure. JSON by default.
    isRequired: true
    types:
    - <xref:str>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.enable_additional_properties_sending
  name: enable_additional_properties_sending
  signature: enable_additional_properties_sending()
- uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.from_dict
  name: from_dict
  summary: 'Parse a dict using given key extractor return a model.


    By default consider key

    extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor

    and last_rest_key_case_insensitive_extractor)'
  signature: from_dict(data, key_extractors=None, content_type=None)
  parameters:
  - name: data
    description: A dict using RestAPI structure
    isRequired: true
    types:
    - <xref:dict>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  - name: key_extractors
    defaultValue: None
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.is_xml_model
  name: is_xml_model
  signature: is_xml_model()
- uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.serialize
  name: serialize
  summary: 'Return the JSON that would be sent to azure from this model.


    This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*.


    If you want XML serialization, you can pass the kwargs is_xml=True.'
  signature: serialize(keep_readonly=False, **kwargs)
  parameters:
  - name: keep_readonly
    description: If you want to serialize the readonly attributes
    defaultValue: 'False'
    types:
    - <xref:bool>
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.validate
  name: validate
  summary: Validate this model recursively and return a list of ValidationError.
  signature: validate()
  return:
    description: A list of validation error
    types:
    - <xref:list>