cloudmersive-nlp-api-client 2.0.2 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +13 -4
  3. data/docs/LanguageTranslationApi.md +118 -0
  4. data/docs/LanguageTranslationRequest.md +8 -0
  5. data/docs/LanguageTranslationResponse.md +10 -0
  6. data/docs/RephraseApi.md +63 -0
  7. data/docs/RephraseRequest.md +9 -0
  8. data/docs/RephraseResponse.md +10 -0
  9. data/docs/RephrasedSentence.md +10 -0
  10. data/docs/RephrasedSentenceOption.md +9 -0
  11. data/lib/cloudmersive-nlp-api-client.rb +8 -0
  12. data/lib/cloudmersive-nlp-api-client/api/language_translation_api.rb +133 -0
  13. data/lib/cloudmersive-nlp-api-client/api/rephrase_api.rb +78 -0
  14. data/lib/cloudmersive-nlp-api-client/models/language_translation_request.rb +189 -0
  15. data/lib/cloudmersive-nlp-api-client/models/language_translation_response.rb +209 -0
  16. data/lib/cloudmersive-nlp-api-client/models/rephrase_request.rb +199 -0
  17. data/lib/cloudmersive-nlp-api-client/models/rephrase_response.rb +211 -0
  18. data/lib/cloudmersive-nlp-api-client/models/rephrased_sentence.rb +211 -0
  19. data/lib/cloudmersive-nlp-api-client/models/rephrased_sentence_option.rb +199 -0
  20. data/lib/cloudmersive-nlp-api-client/version.rb +1 -1
  21. data/spec/api/language_translation_api_spec.rb +59 -0
  22. data/spec/api/rephrase_api_spec.rb +47 -0
  23. data/spec/models/language_translation_request_spec.rb +42 -0
  24. data/spec/models/language_translation_response_spec.rb +54 -0
  25. data/spec/models/rephrase_request_spec.rb +48 -0
  26. data/spec/models/rephrase_response_spec.rb +54 -0
  27. data/spec/models/rephrased_sentence_option_spec.rb +48 -0
  28. data/spec/models/rephrased_sentence_spec.rb +54 -0
  29. metadata +26 -2
@@ -0,0 +1,199 @@
1
+ =begin
2
+ #nlpapiv2
3
+
4
+ #The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module CloudmersiveNlpApiClient
16
+ # One rephrasing of an original input sentence
17
+ class RephrasedSentenceOption
18
+ # Ordered index of the rephrasing option, 1-based, with 1 being the best option
19
+ attr_accessor :rephrased_option_index
20
+
21
+ # One sentence of output rephrased text of original input sentence
22
+ attr_accessor :rephrased_sentence_text
23
+
24
+
25
+ # Attribute mapping from ruby-style variable name to JSON key.
26
+ def self.attribute_map
27
+ {
28
+ :'rephrased_option_index' => :'RephrasedOptionIndex',
29
+ :'rephrased_sentence_text' => :'RephrasedSentenceText'
30
+ }
31
+ end
32
+
33
+ # Attribute type mapping.
34
+ def self.swagger_types
35
+ {
36
+ :'rephrased_option_index' => :'Integer',
37
+ :'rephrased_sentence_text' => :'String'
38
+ }
39
+ end
40
+
41
+ # Initializes the object
42
+ # @param [Hash] attributes Model attributes in the form of hash
43
+ def initialize(attributes = {})
44
+ return unless attributes.is_a?(Hash)
45
+
46
+ # convert string to symbol for hash key
47
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
48
+
49
+ if attributes.has_key?(:'RephrasedOptionIndex')
50
+ self.rephrased_option_index = attributes[:'RephrasedOptionIndex']
51
+ end
52
+
53
+ if attributes.has_key?(:'RephrasedSentenceText')
54
+ self.rephrased_sentence_text = attributes[:'RephrasedSentenceText']
55
+ end
56
+
57
+ end
58
+
59
+ # Show invalid properties with the reasons. Usually used together with valid?
60
+ # @return Array for valid properties with the reasons
61
+ def list_invalid_properties
62
+ invalid_properties = Array.new
63
+ return invalid_properties
64
+ end
65
+
66
+ # Check to see if the all the properties in the model are valid
67
+ # @return true if the model is valid
68
+ def valid?
69
+ return true
70
+ end
71
+
72
+ # Checks equality by comparing each attribute.
73
+ # @param [Object] Object to be compared
74
+ def ==(o)
75
+ return true if self.equal?(o)
76
+ self.class == o.class &&
77
+ rephrased_option_index == o.rephrased_option_index &&
78
+ rephrased_sentence_text == o.rephrased_sentence_text
79
+ end
80
+
81
+ # @see the `==` method
82
+ # @param [Object] Object to be compared
83
+ def eql?(o)
84
+ self == o
85
+ end
86
+
87
+ # Calculates hash code according to all attributes.
88
+ # @return [Fixnum] Hash code
89
+ def hash
90
+ [rephrased_option_index, rephrased_sentence_text].hash
91
+ end
92
+
93
+ # Builds the object from hash
94
+ # @param [Hash] attributes Model attributes in the form of hash
95
+ # @return [Object] Returns the model itself
96
+ def build_from_hash(attributes)
97
+ return nil unless attributes.is_a?(Hash)
98
+ self.class.swagger_types.each_pair do |key, type|
99
+ if type =~ /\AArray<(.*)>/i
100
+ # check to ensure the input is an array given that the the attribute
101
+ # is documented as an array but the input is not
102
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
103
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
104
+ end
105
+ elsif !attributes[self.class.attribute_map[key]].nil?
106
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
107
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
108
+ end
109
+
110
+ self
111
+ end
112
+
113
+ # Deserializes the data based on type
114
+ # @param string type Data type
115
+ # @param string value Value to be deserialized
116
+ # @return [Object] Deserialized data
117
+ def _deserialize(type, value)
118
+ case type.to_sym
119
+ when :DateTime
120
+ DateTime.parse(value)
121
+ when :Date
122
+ Date.parse(value)
123
+ when :String
124
+ value.to_s
125
+ when :Integer
126
+ value.to_i
127
+ when :Float
128
+ value.to_f
129
+ when :BOOLEAN
130
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
131
+ true
132
+ else
133
+ false
134
+ end
135
+ when :Object
136
+ # generic object (usually a Hash), return directly
137
+ value
138
+ when /\AArray<(?<inner_type>.+)>\z/
139
+ inner_type = Regexp.last_match[:inner_type]
140
+ value.map { |v| _deserialize(inner_type, v) }
141
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
142
+ k_type = Regexp.last_match[:k_type]
143
+ v_type = Regexp.last_match[:v_type]
144
+ {}.tap do |hash|
145
+ value.each do |k, v|
146
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
147
+ end
148
+ end
149
+ else # model
150
+ temp_model = CloudmersiveNlpApiClient.const_get(type).new
151
+ temp_model.build_from_hash(value)
152
+ end
153
+ end
154
+
155
+ # Returns the string representation of the object
156
+ # @return [String] String presentation of the object
157
+ def to_s
158
+ to_hash.to_s
159
+ end
160
+
161
+ # to_body is an alias to to_hash (backward compatibility)
162
+ # @return [Hash] Returns the object in the form of hash
163
+ def to_body
164
+ to_hash
165
+ end
166
+
167
+ # Returns the object in the form of hash
168
+ # @return [Hash] Returns the object in the form of hash
169
+ def to_hash
170
+ hash = {}
171
+ self.class.attribute_map.each_pair do |attr, param|
172
+ value = self.send(attr)
173
+ next if value.nil?
174
+ hash[param] = _to_hash(value)
175
+ end
176
+ hash
177
+ end
178
+
179
+ # Outputs non-array value in the form of hash
180
+ # For object, use to_hash. Otherwise, just return the value
181
+ # @param [Object] value Any valid value
182
+ # @return [Hash] Returns the value in the form of hash
183
+ def _to_hash(value)
184
+ if value.is_a?(Array)
185
+ value.compact.map{ |v| _to_hash(v) }
186
+ elsif value.is_a?(Hash)
187
+ {}.tap do |hash|
188
+ value.each { |k, v| hash[k] = _to_hash(v) }
189
+ end
190
+ elsif value.respond_to? :to_hash
191
+ value.to_hash
192
+ else
193
+ value
194
+ end
195
+ end
196
+
197
+ end
198
+
199
+ end
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.3.1
11
11
  =end
12
12
 
13
13
  module CloudmersiveNlpApiClient
14
- VERSION = "2.0.2"
14
+ VERSION = "2.0.3"
15
15
  end
@@ -0,0 +1,59 @@
1
+ =begin
2
+ #nlpapiv2
3
+
4
+ #The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+
16
+ # Unit tests for CloudmersiveNlpApiClient::LanguageTranslationApi
17
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
18
+ # Please update as you see appropriate
19
+ describe 'LanguageTranslationApi' do
20
+ before do
21
+ # run before each test
22
+ @instance = CloudmersiveNlpApiClient::LanguageTranslationApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of LanguageTranslationApi' do
30
+ it 'should create an instance of LanguageTranslationApi' do
31
+ expect(@instance).to be_instance_of(CloudmersiveNlpApiClient::LanguageTranslationApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for language_translation_translate_deu_to_eng
36
+ # Translate German to English text with Deep Learning AI
37
+ # Automatically translates input text in German to output text in English using advanced Deep Learning and Neural NLP. Consumes 1-2 API calls per input sentence.
38
+ # @param input Input translation request
39
+ # @param [Hash] opts the optional parameters
40
+ # @return [LanguageTranslationResponse]
41
+ describe 'language_translation_translate_deu_to_eng test' do
42
+ it "should work" do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ # unit tests for language_translation_translate_eng_to_deu
48
+ # Translate English to German text with Deep Learning AI
49
+ # Automatically translates input text in English to output text in German using advanced Deep Learning and Neural NLP. Consumes 1-2 API calls per input sentence.
50
+ # @param input Input translation request
51
+ # @param [Hash] opts the optional parameters
52
+ # @return [LanguageTranslationResponse]
53
+ describe 'language_translation_translate_eng_to_deu test' do
54
+ it "should work" do
55
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
+ end
57
+ end
58
+
59
+ end
@@ -0,0 +1,47 @@
1
+ =begin
2
+ #nlpapiv2
3
+
4
+ #The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+
16
+ # Unit tests for CloudmersiveNlpApiClient::RephraseApi
17
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
18
+ # Please update as you see appropriate
19
+ describe 'RephraseApi' do
20
+ before do
21
+ # run before each test
22
+ @instance = CloudmersiveNlpApiClient::RephraseApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of RephraseApi' do
30
+ it 'should create an instance of RephraseApi' do
31
+ expect(@instance).to be_instance_of(CloudmersiveNlpApiClient::RephraseApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for rephrase_translate_deu_to_eng
36
+ # Rephrase, paraphrase English text sentence-by-sentence using Deep Learning AI
37
+ # Automatically rephrases or paraphrases input text in English sentence by sentence using advanced Deep Learning and Neural NLP. Creates multiple reprhasing candidates per input sentence, from 1 to 10 possible rephrasings of the original sentence. Seeks to preserve original semantic meaning in rephrased output candidates. Consumes 1-2 API calls per output rephrasing option generated, per sentence.
38
+ # @param input Input rephrase request
39
+ # @param [Hash] opts the optional parameters
40
+ # @return [RephraseResponse]
41
+ describe 'rephrase_translate_deu_to_eng test' do
42
+ it "should work" do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ end
@@ -0,0 +1,42 @@
1
+ =begin
2
+ #nlpapiv2
3
+
4
+ #The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for CloudmersiveNlpApiClient::LanguageTranslationRequest
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'LanguageTranslationRequest' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveNlpApiClient::LanguageTranslationRequest.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of LanguageTranslationRequest' do
31
+ it 'should create an instance of LanguageTranslationRequest' do
32
+ expect(@instance).to be_instance_of(CloudmersiveNlpApiClient::LanguageTranslationRequest)
33
+ end
34
+ end
35
+ describe 'test attribute "text_to_translate"' do
36
+ it 'should work' do
37
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
38
+ end
39
+ end
40
+
41
+ end
42
+
@@ -0,0 +1,54 @@
1
+ =begin
2
+ #nlpapiv2
3
+
4
+ #The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for CloudmersiveNlpApiClient::LanguageTranslationResponse
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'LanguageTranslationResponse' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveNlpApiClient::LanguageTranslationResponse.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of LanguageTranslationResponse' do
31
+ it 'should create an instance of LanguageTranslationResponse' do
32
+ expect(@instance).to be_instance_of(CloudmersiveNlpApiClient::LanguageTranslationResponse)
33
+ end
34
+ end
35
+ describe 'test attribute "successful"' do
36
+ it 'should work' do
37
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
38
+ end
39
+ end
40
+
41
+ describe 'test attribute "translated_text_result"' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ describe 'test attribute "sentence_count"' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
53
+ end
54
+
@@ -0,0 +1,48 @@
1
+ =begin
2
+ #nlpapiv2
3
+
4
+ #The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for CloudmersiveNlpApiClient::RephraseRequest
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'RephraseRequest' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveNlpApiClient::RephraseRequest.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of RephraseRequest' do
31
+ it 'should create an instance of RephraseRequest' do
32
+ expect(@instance).to be_instance_of(CloudmersiveNlpApiClient::RephraseRequest)
33
+ end
34
+ end
35
+ describe 'test attribute "text_to_translate"' do
36
+ it 'should work' do
37
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
38
+ end
39
+ end
40
+
41
+ describe 'test attribute "target_rephrasing_count"' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ end
48
+