Class: Azure::CognitiveServices::ContentModerator::V1_0::Models::OCR

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/1.0/generated/azure_cognitiveservices_contentmoderator/models/ocr.rb

Overview

Contains the text found in image for the language specified.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#cache_id ⇒ String

Returns The cache id.

Returns:

  • (String) —

    The cache id.



25
26
27
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/models/ocr.rb', line 25

def cache_id
  @cache_id
end

#candidates ⇒ Array<Candidate>

Returns The list of candidate text.

Returns:

  • (Array<Candidate>) —

    The list of candidate text.



34
35
36
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/models/ocr.rb', line 34

def candidates
  @candidates
end

#language ⇒ String

Returns The ISO 639-3 code.

Returns:

  • (String) —

    The ISO 639-3 code.



28
29
30
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/models/ocr.rb', line 28

def language
  @language
end

#metadata ⇒ Array<KeyValuePair>

Returns Array of KeyValue.

Returns:



19
20
21
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/models/ocr.rb', line 19

def metadata
  @metadata
end

#status ⇒ Status

Returns The evaluate status.

Returns:

  • (Status) —

    The evaluate status



16
17
18
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/models/ocr.rb', line 16

def status
  @status
end

#text ⇒ String

Returns The found text.

Returns:

  • (String) —

    The found text.



31
32
33
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/models/ocr.rb', line 31

def text
  @text
end

#tracking_id ⇒ String

Returns The tracking id.

Returns:

  • (String) —

    The tracking id.



22
23
24
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/models/ocr.rb', line 22

def tracking_id
  @tracking_id
end

Class Method Details

.mapper ⇒ Object

Mapper for OCR class as Ruby Hash. This will be used for serialization/deserialization.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/models/ocr.rb', line 41

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'OCR',
    type: {
      name: 'Composite',
      class_name: 'OCR',
      model_properties: {
        status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'Status',
          type: {
            name: 'Composite',
            class_name: 'Status'
          }
        },
        metadata: {
          client_side_validation: true,
          required: false,
          serialized_name: 'Metadata',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'KeyValuePairElementType',
                type: {
                  name: 'Composite',
                  class_name: 'KeyValuePair'
                }
            }
          }
        },
        tracking_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'TrackingId',
          type: {
            name: 'String'
          }
        },
        cache_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'CacheId',
          type: {
            name: 'String'
          }
        },
        language: {
          client_side_validation: true,
          required: false,
          serialized_name: 'Language',
          type: {
            name: 'String'
          }
        },
        text: {
          client_side_validation: true,
          required: false,
          serialized_name: 'Text',
          type: {
            name: 'String'
          }
        },
        candidates: {
          client_side_validation: true,
          required: false,
          serialized_name: 'Candidates',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'CandidateElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Candidate'
                }
            }
          }
        }
      }
    }
  }
end