google-cloud-language-v1beta2 0.1.4 → 0.2.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +6 -6
- data/README.md +5 -1
- data/lib/google/cloud/language/v1beta2.rb +1 -1
- data/lib/google/cloud/language/v1beta2/language_service.rb +1 -1
- data/lib/google/cloud/language/v1beta2/language_service/client.rb +148 -143
- data/lib/google/cloud/language/v1beta2/language_service/credentials.rb +1 -1
- data/lib/google/cloud/language/v1beta2/version.rb +1 -1
- data/proto_docs/google/api/resource.rb +12 -12
- data/proto_docs/google/cloud/language/v1beta2/language_service.rb +136 -136
- data/proto_docs/google/protobuf/timestamp.rb +4 -4
- metadata +33 -6
- data/lib/google/cloud/common_resources_pb.rb +0 -15
@@ -24,7 +24,7 @@ module Google
|
|
24
24
|
module V1beta2
|
25
25
|
module LanguageService
|
26
26
|
# Credentials for the LanguageService API.
|
27
|
-
class Credentials < Google::Auth::Credentials
|
27
|
+
class Credentials < ::Google::Auth::Credentials
|
28
28
|
self.scope = [
|
29
29
|
"https://www.googleapis.com/auth/cloud-language",
|
30
30
|
"https://www.googleapis.com/auth/cloud-platform"
|
@@ -128,7 +128,7 @@ module Google
|
|
128
128
|
# - pattern: "shelves/{shelf}"
|
129
129
|
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
130
130
|
# @!attribute [rw] type
|
131
|
-
# @return [String]
|
131
|
+
# @return [::String]
|
132
132
|
# The resource type. It must be in the format of
|
133
133
|
# \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
|
134
134
|
# singular and must not include version numbers.
|
@@ -140,7 +140,7 @@ module Google
|
|
140
140
|
# should use PascalCase (UpperCamelCase). The maximum number of
|
141
141
|
# characters allowed for the `resource_type_kind` is 100.
|
142
142
|
# @!attribute [rw] pattern
|
143
|
-
# @return [Array
|
143
|
+
# @return [::Array<::String>]
|
144
144
|
# Optional. The relative resource name pattern associated with this resource
|
145
145
|
# type. The DNS prefix of the full resource name shouldn't be specified here.
|
146
146
|
#
|
@@ -161,11 +161,11 @@ module Google
|
|
161
161
|
# the same component name (e.g. "project") refers to IDs of the same
|
162
162
|
# type of resource.
|
163
163
|
# @!attribute [rw] name_field
|
164
|
-
# @return [String]
|
164
|
+
# @return [::String]
|
165
165
|
# Optional. The field on the resource that designates the resource name
|
166
166
|
# field. If omitted, this is assumed to be "name".
|
167
167
|
# @!attribute [rw] history
|
168
|
-
# @return [Google::Api::ResourceDescriptor::History]
|
168
|
+
# @return [::Google::Api::ResourceDescriptor::History]
|
169
169
|
# Optional. The historical or future-looking state of the resource pattern.
|
170
170
|
#
|
171
171
|
# Example:
|
@@ -182,19 +182,19 @@ module Google
|
|
182
182
|
# };
|
183
183
|
# }
|
184
184
|
# @!attribute [rw] plural
|
185
|
-
# @return [String]
|
185
|
+
# @return [::String]
|
186
186
|
# The plural name used in the resource name, such as 'projects' for
|
187
187
|
# the name of 'projects/\\{project}'. It is the same concept of the `plural`
|
188
188
|
# field in k8s CRD spec
|
189
189
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
190
190
|
# @!attribute [rw] singular
|
191
|
-
# @return [String]
|
191
|
+
# @return [::String]
|
192
192
|
# The same concept of the `singular` field in k8s CRD spec
|
193
193
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
194
194
|
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
195
195
|
class ResourceDescriptor
|
196
|
-
include Google::Protobuf::MessageExts
|
197
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
196
|
+
include ::Google::Protobuf::MessageExts
|
197
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
198
198
|
|
199
199
|
# A description of the historical or future-looking state of the
|
200
200
|
# resource pattern.
|
@@ -216,7 +216,7 @@ module Google
|
|
216
216
|
# Defines a proto annotation that describes a string field that refers to
|
217
217
|
# an API resource.
|
218
218
|
# @!attribute [rw] type
|
219
|
-
# @return [String]
|
219
|
+
# @return [::String]
|
220
220
|
# The resource type that the annotated field references.
|
221
221
|
#
|
222
222
|
# Example:
|
@@ -227,7 +227,7 @@ module Google
|
|
227
227
|
# }];
|
228
228
|
# }
|
229
229
|
# @!attribute [rw] child_type
|
230
|
-
# @return [String]
|
230
|
+
# @return [::String]
|
231
231
|
# The resource type of a child collection that the annotated field
|
232
232
|
# references. This is useful for annotating the `parent` field that
|
233
233
|
# doesn't have a fixed resource type.
|
@@ -240,8 +240,8 @@ module Google
|
|
240
240
|
# };
|
241
241
|
# }
|
242
242
|
class ResourceReference
|
243
|
-
include Google::Protobuf::MessageExts
|
244
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
243
|
+
include ::Google::Protobuf::MessageExts
|
244
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
245
245
|
end
|
246
246
|
end
|
247
247
|
end
|
@@ -25,21 +25,21 @@ module Google
|
|
25
25
|
#
|
26
26
|
# Represents the input to API methods.
|
27
27
|
# @!attribute [rw] type
|
28
|
-
# @return [Google::Cloud::Language::V1beta2::Document::Type]
|
28
|
+
# @return [::Google::Cloud::Language::V1beta2::Document::Type]
|
29
29
|
# Required. If the type is not set or is `TYPE_UNSPECIFIED`,
|
30
30
|
# returns an `INVALID_ARGUMENT` error.
|
31
31
|
# @!attribute [rw] content
|
32
|
-
# @return [String]
|
32
|
+
# @return [::String]
|
33
33
|
# The content of the input in string format.
|
34
34
|
# Cloud audit logging exempt since it is based on user data.
|
35
35
|
# @!attribute [rw] gcs_content_uri
|
36
|
-
# @return [String]
|
36
|
+
# @return [::String]
|
37
37
|
# The Google Cloud Storage URI where the file content is located.
|
38
38
|
# This URI must be of the form: gs://bucket_name/object_name. For more
|
39
39
|
# details, see https://cloud.google.com/storage/docs/reference-uris.
|
40
40
|
# NOTE: Cloud Storage object versioning is not supported.
|
41
41
|
# @!attribute [rw] language
|
42
|
-
# @return [String]
|
42
|
+
# @return [::String]
|
43
43
|
# The language of the document (if not specified, the language is
|
44
44
|
# automatically detected). Both ISO and BCP-47 language codes are
|
45
45
|
# accepted.<br>
|
@@ -49,8 +49,8 @@ module Google
|
|
49
49
|
# specified by the caller or automatically detected) is not supported by the
|
50
50
|
# called API method, an `INVALID_ARGUMENT` error is returned.
|
51
51
|
class Document
|
52
|
-
include Google::Protobuf::MessageExts
|
53
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
52
|
+
include ::Google::Protobuf::MessageExts
|
53
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
54
54
|
|
55
55
|
# The document types enum.
|
56
56
|
module Type
|
@@ -67,36 +67,36 @@ module Google
|
|
67
67
|
|
68
68
|
# Represents a sentence in the input document.
|
69
69
|
# @!attribute [rw] text
|
70
|
-
# @return [Google::Cloud::Language::V1beta2::TextSpan]
|
70
|
+
# @return [::Google::Cloud::Language::V1beta2::TextSpan]
|
71
71
|
# The sentence text.
|
72
72
|
# @!attribute [rw] sentiment
|
73
|
-
# @return [Google::Cloud::Language::V1beta2::Sentiment]
|
73
|
+
# @return [::Google::Cloud::Language::V1beta2::Sentiment]
|
74
74
|
# For calls to [AnalyzeSentiment][] or if
|
75
|
-
# {Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features#extract_document_sentiment AnnotateTextRequest.Features.extract_document_sentiment} is set to
|
75
|
+
# {::Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features#extract_document_sentiment AnnotateTextRequest.Features.extract_document_sentiment} is set to
|
76
76
|
# true, this field will contain the sentiment for the sentence.
|
77
77
|
class Sentence
|
78
|
-
include Google::Protobuf::MessageExts
|
79
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
78
|
+
include ::Google::Protobuf::MessageExts
|
79
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
80
80
|
end
|
81
81
|
|
82
82
|
# Represents a phrase in the text that is a known entity, such as
|
83
83
|
# a person, an organization, or location. The API associates information, such
|
84
84
|
# as salience and mentions, with entities.
|
85
85
|
# @!attribute [rw] name
|
86
|
-
# @return [String]
|
86
|
+
# @return [::String]
|
87
87
|
# The representative name for the entity.
|
88
88
|
# @!attribute [rw] type
|
89
|
-
# @return [Google::Cloud::Language::V1beta2::Entity::Type]
|
89
|
+
# @return [::Google::Cloud::Language::V1beta2::Entity::Type]
|
90
90
|
# The entity type.
|
91
91
|
# @!attribute [rw] metadata
|
92
|
-
# @return [Google::Protobuf::Map{String => String}]
|
92
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
93
93
|
# Metadata associated with the entity.
|
94
94
|
#
|
95
95
|
# For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
|
96
96
|
# and Knowledge Graph MID (`mid`), if they are available. For the metadata
|
97
97
|
# associated with other entity types, see the Type table below.
|
98
98
|
# @!attribute [rw] salience
|
99
|
-
# @return [Float]
|
99
|
+
# @return [::Float]
|
100
100
|
# The salience score associated with the entity in the [0, 1.0] range.
|
101
101
|
#
|
102
102
|
# The salience score for an entity provides information about the
|
@@ -104,26 +104,26 @@ module Google
|
|
104
104
|
# Scores closer to 0 are less salient, while scores closer to 1.0 are highly
|
105
105
|
# salient.
|
106
106
|
# @!attribute [rw] mentions
|
107
|
-
# @return [Array
|
107
|
+
# @return [::Array<::Google::Cloud::Language::V1beta2::EntityMention>]
|
108
108
|
# The mentions of this entity in the input document. The API currently
|
109
109
|
# supports proper noun mentions.
|
110
110
|
# @!attribute [rw] sentiment
|
111
|
-
# @return [Google::Cloud::Language::V1beta2::Sentiment]
|
111
|
+
# @return [::Google::Cloud::Language::V1beta2::Sentiment]
|
112
112
|
# For calls to [AnalyzeEntitySentiment][] or if
|
113
|
-
# {Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features#extract_entity_sentiment AnnotateTextRequest.Features.extract_entity_sentiment} is set to
|
113
|
+
# {::Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features#extract_entity_sentiment AnnotateTextRequest.Features.extract_entity_sentiment} is set to
|
114
114
|
# true, this field will contain the aggregate sentiment expressed for this
|
115
115
|
# entity in the provided document.
|
116
116
|
class Entity
|
117
|
-
include Google::Protobuf::MessageExts
|
118
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
117
|
+
include ::Google::Protobuf::MessageExts
|
118
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
119
119
|
|
120
120
|
# @!attribute [rw] key
|
121
|
-
# @return [String]
|
121
|
+
# @return [::String]
|
122
122
|
# @!attribute [rw] value
|
123
|
-
# @return [String]
|
123
|
+
# @return [::String]
|
124
124
|
class MetadataEntry
|
125
|
-
include Google::Protobuf::MessageExts
|
126
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
125
|
+
include ::Google::Protobuf::MessageExts
|
126
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
127
127
|
end
|
128
128
|
|
129
129
|
# The type of the entity. For most entity types, the associated metadata is a
|
@@ -208,79 +208,79 @@ module Google
|
|
208
208
|
|
209
209
|
# Represents the smallest syntactic building block of the text.
|
210
210
|
# @!attribute [rw] text
|
211
|
-
# @return [Google::Cloud::Language::V1beta2::TextSpan]
|
211
|
+
# @return [::Google::Cloud::Language::V1beta2::TextSpan]
|
212
212
|
# The token text.
|
213
213
|
# @!attribute [rw] part_of_speech
|
214
|
-
# @return [Google::Cloud::Language::V1beta2::PartOfSpeech]
|
214
|
+
# @return [::Google::Cloud::Language::V1beta2::PartOfSpeech]
|
215
215
|
# Parts of speech tag for this token.
|
216
216
|
# @!attribute [rw] dependency_edge
|
217
|
-
# @return [Google::Cloud::Language::V1beta2::DependencyEdge]
|
217
|
+
# @return [::Google::Cloud::Language::V1beta2::DependencyEdge]
|
218
218
|
# Dependency tree parse for this token.
|
219
219
|
# @!attribute [rw] lemma
|
220
|
-
# @return [String]
|
220
|
+
# @return [::String]
|
221
221
|
# [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
|
222
222
|
class Token
|
223
|
-
include Google::Protobuf::MessageExts
|
224
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
223
|
+
include ::Google::Protobuf::MessageExts
|
224
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
225
225
|
end
|
226
226
|
|
227
227
|
# Represents the feeling associated with the entire text or entities in
|
228
228
|
# the text.
|
229
229
|
# Next ID: 6
|
230
230
|
# @!attribute [rw] magnitude
|
231
|
-
# @return [Float]
|
231
|
+
# @return [::Float]
|
232
232
|
# A non-negative number in the [0, +inf) range, which represents
|
233
233
|
# the absolute magnitude of sentiment regardless of score (positive or
|
234
234
|
# negative).
|
235
235
|
# @!attribute [rw] score
|
236
|
-
# @return [Float]
|
236
|
+
# @return [::Float]
|
237
237
|
# Sentiment score between -1.0 (negative sentiment) and 1.0
|
238
238
|
# (positive sentiment).
|
239
239
|
class Sentiment
|
240
|
-
include Google::Protobuf::MessageExts
|
241
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
240
|
+
include ::Google::Protobuf::MessageExts
|
241
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
242
242
|
end
|
243
243
|
|
244
244
|
# Represents part of speech information for a token.
|
245
245
|
# @!attribute [rw] tag
|
246
|
-
# @return [Google::Cloud::Language::V1beta2::PartOfSpeech::Tag]
|
246
|
+
# @return [::Google::Cloud::Language::V1beta2::PartOfSpeech::Tag]
|
247
247
|
# The part of speech tag.
|
248
248
|
# @!attribute [rw] aspect
|
249
|
-
# @return [Google::Cloud::Language::V1beta2::PartOfSpeech::Aspect]
|
249
|
+
# @return [::Google::Cloud::Language::V1beta2::PartOfSpeech::Aspect]
|
250
250
|
# The grammatical aspect.
|
251
251
|
# @!attribute [rw] case
|
252
|
-
# @return [Google::Cloud::Language::V1beta2::PartOfSpeech::Case]
|
252
|
+
# @return [::Google::Cloud::Language::V1beta2::PartOfSpeech::Case]
|
253
253
|
# The grammatical case.
|
254
254
|
# @!attribute [rw] form
|
255
|
-
# @return [Google::Cloud::Language::V1beta2::PartOfSpeech::Form]
|
255
|
+
# @return [::Google::Cloud::Language::V1beta2::PartOfSpeech::Form]
|
256
256
|
# The grammatical form.
|
257
257
|
# @!attribute [rw] gender
|
258
|
-
# @return [Google::Cloud::Language::V1beta2::PartOfSpeech::Gender]
|
258
|
+
# @return [::Google::Cloud::Language::V1beta2::PartOfSpeech::Gender]
|
259
259
|
# The grammatical gender.
|
260
260
|
# @!attribute [rw] mood
|
261
|
-
# @return [Google::Cloud::Language::V1beta2::PartOfSpeech::Mood]
|
261
|
+
# @return [::Google::Cloud::Language::V1beta2::PartOfSpeech::Mood]
|
262
262
|
# The grammatical mood.
|
263
263
|
# @!attribute [rw] number
|
264
|
-
# @return [Google::Cloud::Language::V1beta2::PartOfSpeech::Number]
|
264
|
+
# @return [::Google::Cloud::Language::V1beta2::PartOfSpeech::Number]
|
265
265
|
# The grammatical number.
|
266
266
|
# @!attribute [rw] person
|
267
|
-
# @return [Google::Cloud::Language::V1beta2::PartOfSpeech::Person]
|
267
|
+
# @return [::Google::Cloud::Language::V1beta2::PartOfSpeech::Person]
|
268
268
|
# The grammatical person.
|
269
269
|
# @!attribute [rw] proper
|
270
|
-
# @return [Google::Cloud::Language::V1beta2::PartOfSpeech::Proper]
|
270
|
+
# @return [::Google::Cloud::Language::V1beta2::PartOfSpeech::Proper]
|
271
271
|
# The grammatical properness.
|
272
272
|
# @!attribute [rw] reciprocity
|
273
|
-
# @return [Google::Cloud::Language::V1beta2::PartOfSpeech::Reciprocity]
|
273
|
+
# @return [::Google::Cloud::Language::V1beta2::PartOfSpeech::Reciprocity]
|
274
274
|
# The grammatical reciprocity.
|
275
275
|
# @!attribute [rw] tense
|
276
|
-
# @return [Google::Cloud::Language::V1beta2::PartOfSpeech::Tense]
|
276
|
+
# @return [::Google::Cloud::Language::V1beta2::PartOfSpeech::Tense]
|
277
277
|
# The grammatical tense.
|
278
278
|
# @!attribute [rw] voice
|
279
|
-
# @return [Google::Cloud::Language::V1beta2::PartOfSpeech::Voice]
|
279
|
+
# @return [::Google::Cloud::Language::V1beta2::PartOfSpeech::Voice]
|
280
280
|
# The grammatical voice.
|
281
281
|
class PartOfSpeech
|
282
|
-
include Google::Protobuf::MessageExts
|
283
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
282
|
+
include ::Google::Protobuf::MessageExts
|
283
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
284
284
|
|
285
285
|
# The part of speech tags enum.
|
286
286
|
module Tag
|
@@ -574,18 +574,18 @@ module Google
|
|
574
574
|
|
575
575
|
# Represents dependency parse tree information for a token.
|
576
576
|
# @!attribute [rw] head_token_index
|
577
|
-
# @return [Integer]
|
577
|
+
# @return [::Integer]
|
578
578
|
# Represents the head of this token in the dependency tree.
|
579
579
|
# This is the index of the token which has an arc going to this token.
|
580
580
|
# The index is the position of the token in the array of tokens returned
|
581
581
|
# by the API method. If this token is a root token, then the
|
582
582
|
# `head_token_index` is its own index.
|
583
583
|
# @!attribute [rw] label
|
584
|
-
# @return [Google::Cloud::Language::V1beta2::DependencyEdge::Label]
|
584
|
+
# @return [::Google::Cloud::Language::V1beta2::DependencyEdge::Label]
|
585
585
|
# The parse label for the token.
|
586
586
|
class DependencyEdge
|
587
|
-
include Google::Protobuf::MessageExts
|
588
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
587
|
+
include ::Google::Protobuf::MessageExts
|
588
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
589
589
|
|
590
590
|
# The parse label enum for the token.
|
591
591
|
module Label
|
@@ -843,20 +843,20 @@ module Google
|
|
843
843
|
# Represents a mention for an entity in the text. Currently, proper noun
|
844
844
|
# mentions are supported.
|
845
845
|
# @!attribute [rw] text
|
846
|
-
# @return [Google::Cloud::Language::V1beta2::TextSpan]
|
846
|
+
# @return [::Google::Cloud::Language::V1beta2::TextSpan]
|
847
847
|
# The mention text.
|
848
848
|
# @!attribute [rw] type
|
849
|
-
# @return [Google::Cloud::Language::V1beta2::EntityMention::Type]
|
849
|
+
# @return [::Google::Cloud::Language::V1beta2::EntityMention::Type]
|
850
850
|
# The type of the entity mention.
|
851
851
|
# @!attribute [rw] sentiment
|
852
|
-
# @return [Google::Cloud::Language::V1beta2::Sentiment]
|
852
|
+
# @return [::Google::Cloud::Language::V1beta2::Sentiment]
|
853
853
|
# For calls to [AnalyzeEntitySentiment][] or if
|
854
|
-
# {Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features#extract_entity_sentiment AnnotateTextRequest.Features.extract_entity_sentiment} is set to
|
854
|
+
# {::Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features#extract_entity_sentiment AnnotateTextRequest.Features.extract_entity_sentiment} is set to
|
855
855
|
# true, this field will contain the sentiment expressed for this mention of
|
856
856
|
# the entity in the provided document.
|
857
857
|
class EntityMention
|
858
|
-
include Google::Protobuf::MessageExts
|
859
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
858
|
+
include ::Google::Protobuf::MessageExts
|
859
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
860
860
|
|
861
861
|
# The supported types of mentions.
|
862
862
|
module Type
|
@@ -873,232 +873,232 @@ module Google
|
|
873
873
|
|
874
874
|
# Represents an output piece of text.
|
875
875
|
# @!attribute [rw] content
|
876
|
-
# @return [String]
|
876
|
+
# @return [::String]
|
877
877
|
# The content of the output text.
|
878
878
|
# @!attribute [rw] begin_offset
|
879
|
-
# @return [Integer]
|
879
|
+
# @return [::Integer]
|
880
880
|
# The API calculates the beginning offset of the content in the original
|
881
|
-
# document according to the {Google::Cloud::Language::V1beta2::EncodingType EncodingType} specified in the API request.
|
881
|
+
# document according to the {::Google::Cloud::Language::V1beta2::EncodingType EncodingType} specified in the API request.
|
882
882
|
class TextSpan
|
883
|
-
include Google::Protobuf::MessageExts
|
884
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
883
|
+
include ::Google::Protobuf::MessageExts
|
884
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
885
885
|
end
|
886
886
|
|
887
887
|
# Represents a category returned from the text classifier.
|
888
888
|
# @!attribute [rw] name
|
889
|
-
# @return [String]
|
889
|
+
# @return [::String]
|
890
890
|
# The name of the category representing the document, from the [predefined
|
891
891
|
# taxonomy](https://cloud.google.com/natural-language/docs/categories).
|
892
892
|
# @!attribute [rw] confidence
|
893
|
-
# @return [Float]
|
893
|
+
# @return [::Float]
|
894
894
|
# The classifier's confidence of the category. Number represents how certain
|
895
895
|
# the classifier is that this category represents the given text.
|
896
896
|
class ClassificationCategory
|
897
|
-
include Google::Protobuf::MessageExts
|
898
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
897
|
+
include ::Google::Protobuf::MessageExts
|
898
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
899
899
|
end
|
900
900
|
|
901
901
|
# The sentiment analysis request message.
|
902
902
|
# @!attribute [rw] document
|
903
|
-
# @return [Google::Cloud::Language::V1beta2::Document]
|
903
|
+
# @return [::Google::Cloud::Language::V1beta2::Document]
|
904
904
|
# Required. Input document.
|
905
905
|
# @!attribute [rw] encoding_type
|
906
|
-
# @return [Google::Cloud::Language::V1beta2::EncodingType]
|
906
|
+
# @return [::Google::Cloud::Language::V1beta2::EncodingType]
|
907
907
|
# The encoding type used by the API to calculate sentence offsets for the
|
908
908
|
# sentence sentiment.
|
909
909
|
class AnalyzeSentimentRequest
|
910
|
-
include Google::Protobuf::MessageExts
|
911
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
910
|
+
include ::Google::Protobuf::MessageExts
|
911
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
912
912
|
end
|
913
913
|
|
914
914
|
# The sentiment analysis response message.
|
915
915
|
# @!attribute [rw] document_sentiment
|
916
|
-
# @return [Google::Cloud::Language::V1beta2::Sentiment]
|
916
|
+
# @return [::Google::Cloud::Language::V1beta2::Sentiment]
|
917
917
|
# The overall sentiment of the input document.
|
918
918
|
# @!attribute [rw] language
|
919
|
-
# @return [String]
|
919
|
+
# @return [::String]
|
920
920
|
# The language of the text, which will be the same as the language specified
|
921
921
|
# in the request or, if not specified, the automatically-detected language.
|
922
|
-
# See {Google::Cloud::Language::V1beta2::Document#language Document.language} field for more details.
|
922
|
+
# See {::Google::Cloud::Language::V1beta2::Document#language Document.language} field for more details.
|
923
923
|
# @!attribute [rw] sentences
|
924
|
-
# @return [Array
|
924
|
+
# @return [::Array<::Google::Cloud::Language::V1beta2::Sentence>]
|
925
925
|
# The sentiment for all the sentences in the document.
|
926
926
|
class AnalyzeSentimentResponse
|
927
|
-
include Google::Protobuf::MessageExts
|
928
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
927
|
+
include ::Google::Protobuf::MessageExts
|
928
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
929
929
|
end
|
930
930
|
|
931
931
|
# The entity-level sentiment analysis request message.
|
932
932
|
# @!attribute [rw] document
|
933
|
-
# @return [Google::Cloud::Language::V1beta2::Document]
|
933
|
+
# @return [::Google::Cloud::Language::V1beta2::Document]
|
934
934
|
# Required. Input document.
|
935
935
|
# @!attribute [rw] encoding_type
|
936
|
-
# @return [Google::Cloud::Language::V1beta2::EncodingType]
|
936
|
+
# @return [::Google::Cloud::Language::V1beta2::EncodingType]
|
937
937
|
# The encoding type used by the API to calculate offsets.
|
938
938
|
class AnalyzeEntitySentimentRequest
|
939
|
-
include Google::Protobuf::MessageExts
|
940
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
939
|
+
include ::Google::Protobuf::MessageExts
|
940
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
941
941
|
end
|
942
942
|
|
943
943
|
# The entity-level sentiment analysis response message.
|
944
944
|
# @!attribute [rw] entities
|
945
|
-
# @return [Array
|
945
|
+
# @return [::Array<::Google::Cloud::Language::V1beta2::Entity>]
|
946
946
|
# The recognized entities in the input document with associated sentiments.
|
947
947
|
# @!attribute [rw] language
|
948
|
-
# @return [String]
|
948
|
+
# @return [::String]
|
949
949
|
# The language of the text, which will be the same as the language specified
|
950
950
|
# in the request or, if not specified, the automatically-detected language.
|
951
|
-
# See {Google::Cloud::Language::V1beta2::Document#language Document.language} field for more details.
|
951
|
+
# See {::Google::Cloud::Language::V1beta2::Document#language Document.language} field for more details.
|
952
952
|
class AnalyzeEntitySentimentResponse
|
953
|
-
include Google::Protobuf::MessageExts
|
954
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
953
|
+
include ::Google::Protobuf::MessageExts
|
954
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
955
955
|
end
|
956
956
|
|
957
957
|
# The entity analysis request message.
|
958
958
|
# @!attribute [rw] document
|
959
|
-
# @return [Google::Cloud::Language::V1beta2::Document]
|
959
|
+
# @return [::Google::Cloud::Language::V1beta2::Document]
|
960
960
|
# Required. Input document.
|
961
961
|
# @!attribute [rw] encoding_type
|
962
|
-
# @return [Google::Cloud::Language::V1beta2::EncodingType]
|
962
|
+
# @return [::Google::Cloud::Language::V1beta2::EncodingType]
|
963
963
|
# The encoding type used by the API to calculate offsets.
|
964
964
|
class AnalyzeEntitiesRequest
|
965
|
-
include Google::Protobuf::MessageExts
|
966
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
965
|
+
include ::Google::Protobuf::MessageExts
|
966
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
967
967
|
end
|
968
968
|
|
969
969
|
# The entity analysis response message.
|
970
970
|
# @!attribute [rw] entities
|
971
|
-
# @return [Array
|
971
|
+
# @return [::Array<::Google::Cloud::Language::V1beta2::Entity>]
|
972
972
|
# The recognized entities in the input document.
|
973
973
|
# @!attribute [rw] language
|
974
|
-
# @return [String]
|
974
|
+
# @return [::String]
|
975
975
|
# The language of the text, which will be the same as the language specified
|
976
976
|
# in the request or, if not specified, the automatically-detected language.
|
977
|
-
# See {Google::Cloud::Language::V1beta2::Document#language Document.language} field for more details.
|
977
|
+
# See {::Google::Cloud::Language::V1beta2::Document#language Document.language} field for more details.
|
978
978
|
class AnalyzeEntitiesResponse
|
979
|
-
include Google::Protobuf::MessageExts
|
980
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
979
|
+
include ::Google::Protobuf::MessageExts
|
980
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
981
981
|
end
|
982
982
|
|
983
983
|
# The syntax analysis request message.
|
984
984
|
# @!attribute [rw] document
|
985
|
-
# @return [Google::Cloud::Language::V1beta2::Document]
|
985
|
+
# @return [::Google::Cloud::Language::V1beta2::Document]
|
986
986
|
# Required. Input document.
|
987
987
|
# @!attribute [rw] encoding_type
|
988
|
-
# @return [Google::Cloud::Language::V1beta2::EncodingType]
|
988
|
+
# @return [::Google::Cloud::Language::V1beta2::EncodingType]
|
989
989
|
# The encoding type used by the API to calculate offsets.
|
990
990
|
class AnalyzeSyntaxRequest
|
991
|
-
include Google::Protobuf::MessageExts
|
992
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
991
|
+
include ::Google::Protobuf::MessageExts
|
992
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
993
993
|
end
|
994
994
|
|
995
995
|
# The syntax analysis response message.
|
996
996
|
# @!attribute [rw] sentences
|
997
|
-
# @return [Array
|
997
|
+
# @return [::Array<::Google::Cloud::Language::V1beta2::Sentence>]
|
998
998
|
# Sentences in the input document.
|
999
999
|
# @!attribute [rw] tokens
|
1000
|
-
# @return [Array
|
1000
|
+
# @return [::Array<::Google::Cloud::Language::V1beta2::Token>]
|
1001
1001
|
# Tokens, along with their syntactic information, in the input document.
|
1002
1002
|
# @!attribute [rw] language
|
1003
|
-
# @return [String]
|
1003
|
+
# @return [::String]
|
1004
1004
|
# The language of the text, which will be the same as the language specified
|
1005
1005
|
# in the request or, if not specified, the automatically-detected language.
|
1006
|
-
# See {Google::Cloud::Language::V1beta2::Document#language Document.language} field for more details.
|
1006
|
+
# See {::Google::Cloud::Language::V1beta2::Document#language Document.language} field for more details.
|
1007
1007
|
class AnalyzeSyntaxResponse
|
1008
|
-
include Google::Protobuf::MessageExts
|
1009
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
1008
|
+
include ::Google::Protobuf::MessageExts
|
1009
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1010
1010
|
end
|
1011
1011
|
|
1012
1012
|
# The document classification request message.
|
1013
1013
|
# @!attribute [rw] document
|
1014
|
-
# @return [Google::Cloud::Language::V1beta2::Document]
|
1014
|
+
# @return [::Google::Cloud::Language::V1beta2::Document]
|
1015
1015
|
# Required. Input document.
|
1016
1016
|
class ClassifyTextRequest
|
1017
|
-
include Google::Protobuf::MessageExts
|
1018
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
1017
|
+
include ::Google::Protobuf::MessageExts
|
1018
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1019
1019
|
end
|
1020
1020
|
|
1021
1021
|
# The document classification response message.
|
1022
1022
|
# @!attribute [rw] categories
|
1023
|
-
# @return [Array
|
1023
|
+
# @return [::Array<::Google::Cloud::Language::V1beta2::ClassificationCategory>]
|
1024
1024
|
# Categories representing the input document.
|
1025
1025
|
class ClassifyTextResponse
|
1026
|
-
include Google::Protobuf::MessageExts
|
1027
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
1026
|
+
include ::Google::Protobuf::MessageExts
|
1027
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1028
1028
|
end
|
1029
1029
|
|
1030
1030
|
# The request message for the text annotation API, which can perform multiple
|
1031
1031
|
# analysis types (sentiment, entities, and syntax) in one call.
|
1032
1032
|
# @!attribute [rw] document
|
1033
|
-
# @return [Google::Cloud::Language::V1beta2::Document]
|
1033
|
+
# @return [::Google::Cloud::Language::V1beta2::Document]
|
1034
1034
|
# Required. Input document.
|
1035
1035
|
# @!attribute [rw] features
|
1036
|
-
# @return [Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features]
|
1036
|
+
# @return [::Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features]
|
1037
1037
|
# Required. The enabled features.
|
1038
1038
|
# @!attribute [rw] encoding_type
|
1039
|
-
# @return [Google::Cloud::Language::V1beta2::EncodingType]
|
1039
|
+
# @return [::Google::Cloud::Language::V1beta2::EncodingType]
|
1040
1040
|
# The encoding type used by the API to calculate offsets.
|
1041
1041
|
class AnnotateTextRequest
|
1042
|
-
include Google::Protobuf::MessageExts
|
1043
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
1042
|
+
include ::Google::Protobuf::MessageExts
|
1043
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1044
1044
|
|
1045
1045
|
# All available features for sentiment, syntax, and semantic analysis.
|
1046
1046
|
# Setting each one to true will enable that specific analysis for the input.
|
1047
1047
|
# Next ID: 10
|
1048
1048
|
# @!attribute [rw] extract_syntax
|
1049
|
-
# @return [Boolean]
|
1049
|
+
# @return [::Boolean]
|
1050
1050
|
# Extract syntax information.
|
1051
1051
|
# @!attribute [rw] extract_entities
|
1052
|
-
# @return [Boolean]
|
1052
|
+
# @return [::Boolean]
|
1053
1053
|
# Extract entities.
|
1054
1054
|
# @!attribute [rw] extract_document_sentiment
|
1055
|
-
# @return [Boolean]
|
1055
|
+
# @return [::Boolean]
|
1056
1056
|
# Extract document-level sentiment.
|
1057
1057
|
# @!attribute [rw] extract_entity_sentiment
|
1058
|
-
# @return [Boolean]
|
1058
|
+
# @return [::Boolean]
|
1059
1059
|
# Extract entities and their associated sentiment.
|
1060
1060
|
# @!attribute [rw] classify_text
|
1061
|
-
# @return [Boolean]
|
1061
|
+
# @return [::Boolean]
|
1062
1062
|
# Classify the full document into categories. If this is true,
|
1063
1063
|
# the API will use the default model which classifies into a
|
1064
1064
|
# [predefined
|
1065
1065
|
# taxonomy](https://cloud.google.com/natural-language/docs/categories).
|
1066
1066
|
class Features
|
1067
|
-
include Google::Protobuf::MessageExts
|
1068
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
1067
|
+
include ::Google::Protobuf::MessageExts
|
1068
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1069
1069
|
end
|
1070
1070
|
end
|
1071
1071
|
|
1072
1072
|
# The text annotations response message.
|
1073
1073
|
# @!attribute [rw] sentences
|
1074
|
-
# @return [Array
|
1074
|
+
# @return [::Array<::Google::Cloud::Language::V1beta2::Sentence>]
|
1075
1075
|
# Sentences in the input document. Populated if the user enables
|
1076
|
-
# {Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features#extract_syntax AnnotateTextRequest.Features.extract_syntax}.
|
1076
|
+
# {::Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features#extract_syntax AnnotateTextRequest.Features.extract_syntax}.
|
1077
1077
|
# @!attribute [rw] tokens
|
1078
|
-
# @return [Array
|
1078
|
+
# @return [::Array<::Google::Cloud::Language::V1beta2::Token>]
|
1079
1079
|
# Tokens, along with their syntactic information, in the input document.
|
1080
1080
|
# Populated if the user enables
|
1081
|
-
# {Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features#extract_syntax AnnotateTextRequest.Features.extract_syntax}.
|
1081
|
+
# {::Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features#extract_syntax AnnotateTextRequest.Features.extract_syntax}.
|
1082
1082
|
# @!attribute [rw] entities
|
1083
|
-
# @return [Array
|
1083
|
+
# @return [::Array<::Google::Cloud::Language::V1beta2::Entity>]
|
1084
1084
|
# Entities, along with their semantic information, in the input document.
|
1085
1085
|
# Populated if the user enables
|
1086
|
-
# {Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features#extract_entities AnnotateTextRequest.Features.extract_entities}.
|
1086
|
+
# {::Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features#extract_entities AnnotateTextRequest.Features.extract_entities}.
|
1087
1087
|
# @!attribute [rw] document_sentiment
|
1088
|
-
# @return [Google::Cloud::Language::V1beta2::Sentiment]
|
1088
|
+
# @return [::Google::Cloud::Language::V1beta2::Sentiment]
|
1089
1089
|
# The overall sentiment for the document. Populated if the user enables
|
1090
|
-
# {Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features#extract_document_sentiment AnnotateTextRequest.Features.extract_document_sentiment}.
|
1090
|
+
# {::Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features#extract_document_sentiment AnnotateTextRequest.Features.extract_document_sentiment}.
|
1091
1091
|
# @!attribute [rw] language
|
1092
|
-
# @return [String]
|
1092
|
+
# @return [::String]
|
1093
1093
|
# The language of the text, which will be the same as the language specified
|
1094
1094
|
# in the request or, if not specified, the automatically-detected language.
|
1095
|
-
# See {Google::Cloud::Language::V1beta2::Document#language Document.language} field for more details.
|
1095
|
+
# See {::Google::Cloud::Language::V1beta2::Document#language Document.language} field for more details.
|
1096
1096
|
# @!attribute [rw] categories
|
1097
|
-
# @return [Array
|
1097
|
+
# @return [::Array<::Google::Cloud::Language::V1beta2::ClassificationCategory>]
|
1098
1098
|
# Categories identified in the input document.
|
1099
1099
|
class AnnotateTextResponse
|
1100
|
-
include Google::Protobuf::MessageExts
|
1101
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
1100
|
+
include ::Google::Protobuf::MessageExts
|
1101
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1102
1102
|
end
|
1103
1103
|
|
1104
1104
|
# Represents the text encoding that the caller uses to process the output.
|