1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module LanguageV1beta2
# Cloud Natural Language API
#
# Provides natural language understanding technologies, such as sentiment
# analysis, entity recognition, entity sentiment analysis, and other text
# annotations, to developers.
#
# @example
# require 'google/apis/language_v1beta2'
#
# Language = Google::Apis::LanguageV1beta2 # Alias the module
# service = Language::CloudNaturalLanguageService.new
#
# @see https://cloud.google.com/natural-language/
class CloudNaturalLanguageService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://language.googleapis.com/', '')
@batch_path = 'batch'
end
# Finds named entities (currently proper names and common nouns) in the text
# along with entity types, salience, mentions for each entity, and other
# properties.
# @param [Google::Apis::LanguageV1beta2::AnalyzeEntitiesRequest] analyze_entities_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LanguageV1beta2::AnalyzeEntitiesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LanguageV1beta2::AnalyzeEntitiesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def analyze_document_entities(analyze_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta2/documents:analyzeEntities', options)
command.request_representation = Google::Apis::LanguageV1beta2::AnalyzeEntitiesRequest::Representation
command.request_object = analyze_entities_request_object
command.response_representation = Google::Apis::LanguageV1beta2::AnalyzeEntitiesResponse::Representation
command.response_class = Google::Apis::LanguageV1beta2::AnalyzeEntitiesResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment
# associated with each entity and its mentions.
# @param [Google::Apis::LanguageV1beta2::AnalyzeEntitySentimentRequest] analyze_entity_sentiment_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LanguageV1beta2::AnalyzeEntitySentimentResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LanguageV1beta2::AnalyzeEntitySentimentResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def analyze_document_entity_sentiment(analyze_entity_sentiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta2/documents:analyzeEntitySentiment', options)
command.request_representation = Google::Apis::LanguageV1beta2::AnalyzeEntitySentimentRequest::Representation
command.request_object = analyze_entity_sentiment_request_object
command.response_representation = Google::Apis::LanguageV1beta2::AnalyzeEntitySentimentResponse::Representation
command.response_class = Google::Apis::LanguageV1beta2::AnalyzeEntitySentimentResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Analyzes the sentiment of the provided text.
# @param [Google::Apis::LanguageV1beta2::AnalyzeSentimentRequest] analyze_sentiment_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LanguageV1beta2::AnalyzeSentimentResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LanguageV1beta2::AnalyzeSentimentResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def analyze_document_sentiment(analyze_sentiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta2/documents:analyzeSentiment', options)
command.request_representation = Google::Apis::LanguageV1beta2::AnalyzeSentimentRequest::Representation
command.request_object = analyze_sentiment_request_object
command.response_representation = Google::Apis::LanguageV1beta2::AnalyzeSentimentResponse::Representation
command.response_class = Google::Apis::LanguageV1beta2::AnalyzeSentimentResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Analyzes the syntax of the text and provides sentence boundaries and
# tokenization along with part of speech tags, dependency trees, and other
# properties.
# @param [Google::Apis::LanguageV1beta2::AnalyzeSyntaxRequest] analyze_syntax_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LanguageV1beta2::AnalyzeSyntaxResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LanguageV1beta2::AnalyzeSyntaxResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def analyze_document_syntax(analyze_syntax_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta2/documents:analyzeSyntax', options)
command.request_representation = Google::Apis::LanguageV1beta2::AnalyzeSyntaxRequest::Representation
command.request_object = analyze_syntax_request_object
command.response_representation = Google::Apis::LanguageV1beta2::AnalyzeSyntaxResponse::Representation
command.response_class = Google::Apis::LanguageV1beta2::AnalyzeSyntaxResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# A convenience method that provides all syntax, sentiment, entity, and
# classification features in one call.
# @param [Google::Apis::LanguageV1beta2::AnnotateTextRequest] annotate_text_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LanguageV1beta2::AnnotateTextResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LanguageV1beta2::AnnotateTextResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def annotate_document_text(annotate_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta2/documents:annotateText', options)
command.request_representation = Google::Apis::LanguageV1beta2::AnnotateTextRequest::Representation
command.request_object = annotate_text_request_object
command.response_representation = Google::Apis::LanguageV1beta2::AnnotateTextResponse::Representation
command.response_class = Google::Apis::LanguageV1beta2::AnnotateTextResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Classifies a document into categories.
# @param [Google::Apis::LanguageV1beta2::ClassifyTextRequest] classify_text_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LanguageV1beta2::ClassifyTextResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LanguageV1beta2::ClassifyTextResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def classify_document_text(classify_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta2/documents:classifyText', options)
command.request_representation = Google::Apis::LanguageV1beta2::ClassifyTextRequest::Representation
command.request_object = classify_text_request_object
command.response_representation = Google::Apis::LanguageV1beta2::ClassifyTextResponse::Representation
command.response_class = Google::Apis::LanguageV1beta2::ClassifyTextResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|
