Class: Azure::CognitiveServices::TextAnalytics::V2_0::Models::EntityRecord

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/v2.0/generated/azure_cognitiveservices_textanalytics/models/entity_record.rb

Overview

Model object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#bing_id ⇒ String

in conjunction with the Bing Entity Search API to fetch additional relevant information.

Returns:

  • (String) —

    Bing unique identifier of the recognized entity. Use



36
37
38
 
# File 'lib/v2.0/generated/azure_cognitiveservices_textanalytics/models/entity_record.rb', line 36

def bing_id
  @bing_id
end

#matches ⇒ Array<MatchRecord>

the text.

Returns:

  • (Array<MatchRecord>) —

    List of instances this entity appears in



21
22
23
 
# File 'lib/v2.0/generated/azure_cognitiveservices_textanalytics/models/entity_record.rb', line 21

def matches
  @matches
end

#name ⇒ String

Returns Entity formal name.

Returns:

  • (String) —

    Entity formal name.



17
18
19
 
# File 'lib/v2.0/generated/azure_cognitiveservices_textanalytics/models/entity_record.rb', line 17

def name
  @name
end

#wikipedia_id ⇒ String

Returns Wikipedia unique identifier of the recognized entity.

Returns:

  • (String) —

    Wikipedia unique identifier of the recognized entity.



28
29
30
 
# File 'lib/v2.0/generated/azure_cognitiveservices_textanalytics/models/entity_record.rb', line 28

def wikipedia_id
  @wikipedia_id
end

#wikipedia_language ⇒ String

WikipediaUrl refers to.

Returns:

  • (String) —

    Wikipedia language for which the WikipediaId and



25
26
27
 
# File 'lib/v2.0/generated/azure_cognitiveservices_textanalytics/models/entity_record.rb', line 25

def wikipedia_language
  @wikipedia_language
end

#wikipedia_url ⇒ String

Returns URL for the entity’s English Wikipedia page.

Returns:

  • (String) —

    URL for the entity’s English Wikipedia page.



31
32
33
 
# File 'lib/v2.0/generated/azure_cognitiveservices_textanalytics/models/entity_record.rb', line 31

def wikipedia_url
  @wikipedia_url
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/v2.0/generated/azure_cognitiveservices_textanalytics/models/entity_record.rb', line 43

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'EntityRecord',
    type: {
      name: 'Composite',
      class_name: 'EntityRecord',
      model_properties: {
        name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        matches: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'matches',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'MatchRecordElementType',
                type: {
                  name: 'Composite',
                  class_name: 'MatchRecord'
                }
            }
          }
        },
        wikipedia_language: {
          client_side_validation: true,
          required: false,
          serialized_name: 'wikipediaLanguage',
          type: {
            name: 'String'
          }
        },
        wikipedia_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'wikipediaId',
          type: {
            name: 'String'
          }
        },
        wikipedia_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'wikipediaUrl',
          type: {
            name: 'String'
          }
        },
        bing_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'bingId',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end