Class: Azure::CognitiveServices::TextAnalytics::V2_1::Models::KeyPhraseBatchResultItem

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

Overview

Model object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#id ⇒ String

Returns Unique, non-empty document identifier.

Returns:

  • (String) —

    Unique, non-empty document identifier.



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

def id
  @id
end

#key_phrases ⇒ Array<String>

number of key phrases returned is proportional to the number of words in the input document.

Returns:

  • (Array<String>) —

    A list of representative words or phrases. The



22
23
24
 
# File 'lib/v2.1/generated/azure_cognitiveservices_textanalytics/models/key_phrase_batch_result_item.rb', line 22

def key_phrases
  @key_phrases
end

#statistics ⇒ DocumentStatistics

in the request this field will contain information about the document payload.

Returns:



27
28
29
 
# File 'lib/v2.1/generated/azure_cognitiveservices_textanalytics/models/key_phrase_batch_result_item.rb', line 27

def statistics
  @statistics
end

Class Method Details

.mapper ⇒ Object

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



34
35
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
 
# File 'lib/v2.1/generated/azure_cognitiveservices_textanalytics/models/key_phrase_batch_result_item.rb', line 34

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'KeyPhraseBatchResultItem',
    type: {
      name: 'Composite',
      class_name: 'KeyPhraseBatchResultItem',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        key_phrases: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'keyPhrases',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        statistics: {
          client_side_validation: true,
          required: false,
          serialized_name: 'statistics',
          type: {
            name: 'Composite',
            class_name: 'DocumentStatistics'
          }
        }
      }
    }
  }
end