Class: CloudmersiveNlpApiClient::SegmentationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-nlp-api-client/api/segmentation_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SegmentationApi

Returns a new instance of SegmentationApi.



19
20
21
 
# File 'lib/cloudmersive-nlp-api-client/api/segmentation_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudmersive-nlp-api-client/api/segmentation_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#segmentation_get_sentences(input, opts = {}) ⇒ SentenceSegmentationResponse

Extract sentences from string Segment an input string into separate sentences, output result as a string.

Parameters:

  • input —

    Input string

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/cloudmersive-nlp-api-client/api/segmentation_api.rb', line 28

def segmentation_get_sentences(input, opts = {})
  data, _status_code, _headers = segmentation_get_sentences_with_http_info(input, opts)
  return data
end

#segmentation_get_sentences_with_http_info(input, opts = {}) ⇒ Array<(SentenceSegmentationResponse, Fixnum, Hash)>

Extract sentences from string Segment an input string into separate sentences, output result as a string.

Parameters:

  • input —

    Input string

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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
 
# File 'lib/cloudmersive-nlp-api-client/api/segmentation_api.rb', line 38

def segmentation_get_sentences_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SegmentationApi.segmentation_get_sentences ..."
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling SegmentationApi.segmentation_get_sentences"
  end
  # resource path
  local_var_path = "/nlp-v2/segmentation/sentences"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(input)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SentenceSegmentationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SegmentationApi#segmentation_get_sentences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#segmentation_get_words(input, opts = {}) ⇒ GetWordsResponse

Get words in input string Get the component words in an input string

Parameters:

  • input —

    String to process

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/cloudmersive-nlp-api-client/api/segmentation_api.rb', line 83

def segmentation_get_words(input, opts = {})
  data, _status_code, _headers = segmentation_get_words_with_http_info(input, opts)
  return data
end

#segmentation_get_words_with_http_info(input, opts = {}) ⇒ Array<(GetWordsResponse, Fixnum, Hash)>

Get words in input string Get the component words in an input string

Parameters:

  • input —

    String to process

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetWordsResponse, Fixnum, Hash)>) —

    GetWordsResponse data, response status code and response headers



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
 
# File 'lib/cloudmersive-nlp-api-client/api/segmentation_api.rb', line 93

def segmentation_get_words_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SegmentationApi.segmentation_get_words ..."
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling SegmentationApi.segmentation_get_words"
  end
  # resource path
  local_var_path = "/nlp-v2/segmentation/words"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(input)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GetWordsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SegmentationApi#segmentation_get_words\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end