Class: Azure::CognitiveServices::LocalSearch::V1_0::Models::EntitiesEntityPresentationInfo

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

Overview

Defines additional information about an entity such as type hints.

Constant Summary collapse

@@discriminatorMap = 
Hash.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ EntitiesEntityPresentationInfo

Returns a new instance of EntitiesEntityPresentationInfo.



17
18
19
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/entities_entity_presentation_info.rb', line 17

def initialize
  @_type = "Entities/EntityPresentationInfo"
end

Instance Attribute Details

#_type ⇒ Object

Returns the value of attribute _type.



21
22
23
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/entities_entity_presentation_info.rb', line 21

def _type
  @_type
end

#entity_scenario ⇒ EntityScenario

include: ‘DominantEntity’, ‘DisambiguationItem’, ‘ListItem’. Default value: ‘DominantEntity’ .

Returns:



26
27
28
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/entities_entity_presentation_info.rb', line 26

def entity_scenario
  @entity_scenario
end

#entity_sub_type_hints ⇒ Array<String>

Returns:

  • (Array<String>) 


42
43
44
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/entities_entity_presentation_info.rb', line 42

def entity_sub_type_hints
  @entity_sub_type_hints
end

#entity_type_display_hint ⇒ String

entityTypeHints is Artist, this field may be set to American Singer.

Returns:

  • (String) —

    A display version of the entity hint. For example, if



36
37
38
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/entities_entity_presentation_info.rb', line 36

def entity_type_display_hint
  @entity_type_display_hint
end

#entity_type_hints ⇒ Array<EntityType>

type. The list could contain a single hint such as Movie or a list of hints such as Place, LocalBusiness, Restaurant. Each successive hint in the array narrows the entity’s type.

Returns:

  • (Array<EntityType>) —

    A list of hints that indicate the entity’s



32
33
34
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/entities_entity_presentation_info.rb', line 32

def entity_type_hints
  @entity_type_hints
end

#query ⇒ String

Returns:

  • (String) 


39
40
41
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/entities_entity_presentation_info.rb', line 39

def query
  @query
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/entities_entity_presentation_info.rb', line 49

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Entities/EntityPresentationInfo',
    type: {
      name: 'Composite',
      polymorphic_discriminator: '_type',
      uber_parent: 'EntitiesEntityPresentationInfo',
      class_name: 'EntitiesEntityPresentationInfo',
      model_properties: {
        entity_scenario: {
          client_side_validation: true,
          required: true,
          serialized_name: 'entityScenario',
          default_value: 'DominantEntity',
          type: {
            name: 'String'
          }
        },
        entity_type_hints: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'entityTypeHints',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'EntityTypeElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        entity_type_display_hint: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'entityTypeDisplayHint',
          type: {
            name: 'String'
          }
        },
        query: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'query',
          type: {
            name: 'String'
          }
        },
        entity_sub_type_hints: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'entitySubTypeHints',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        }
      }
    }
  }
end