Class: Azure::CognitiveServices::ImageSearch::V1_0::Models::RecognizedEntity

Inherits:
Response show all
Includes:
MsRestAzure
Defined in:
lib/1.0/generated/azure_cognitiveservices_imagesearch/models/recognized_entity.rb

Overview

Defines a recognized entity.

Instance Attribute Summary collapse

Attributes inherited from Response

#read_link, #web_search_url

Attributes inherited from Identifiable

#id

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ RecognizedEntity

Returns a new instance of RecognizedEntity.



16
17
18
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/recognized_entity.rb', line 16

def initialize
  @_type = "RecognizedEntity"
end

Instance Attribute Details

#_type ⇒ Object

Returns the value of attribute _type.



20
21
22
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/recognized_entity.rb', line 20

def _type
  @_type
end

#entity ⇒ Thing

possible entity objects: Person

Returns:

  • (Thing) —

    The entity that was recognized. The following are the



24
25
26
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/recognized_entity.rb', line 24

def entity
  @entity
end

#match_confidence ⇒ Float

image matches this entity. The confidence ranges from 0.0 through 1.0 with 1.0 being very confident.

Returns:

  • (Float) —

    The confidence that Bing has that the entity in the



29
30
31
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/recognized_entity.rb', line 29

def match_confidence
  @match_confidence
end

Class Method Details

.mapper ⇒ Object

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



36
37
38
39
40
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
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/recognized_entity.rb', line 36

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'RecognizedEntity',
    type: {
      name: 'Composite',
      class_name: 'RecognizedEntity',
      model_properties: {
        _type: {
          client_side_validation: true,
          required: true,
          serialized_name: '_type',
          type: {
            name: 'String'
          }
        },
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        read_link: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'readLink',
          type: {
            name: 'String'
          }
        },
        web_search_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'webSearchUrl',
          type: {
            name: 'String'
          }
        },
        entity: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'entity',
          type: {
            name: 'Composite',
            class_name: 'Thing'
          }
        },
        match_confidence: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'matchConfidence',
          type: {
            name: 'Double'
          }
        }
      }
    }
  }
end