Class: PureCloud::SpeechTextAnalyticsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SpeechTextAnalyticsApi

Returns a new instance of SpeechTextAnalyticsApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#get_speechandtextanalytics_conversation(conversation_id, opts = {}) ⇒ ConversationMetrics

Get Speech and Text Analytics for a specific conversation

Parameters:

  • conversation_id —

    Conversation Id

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

    the optional parameters

Returns:



32
33
34
35
 
# File 'lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb', line 32

def get_speechandtextanalytics_conversation(conversation_id, opts = {})
  data, _status_code, _headers = get_speechandtextanalytics_conversation_with_http_info(conversation_id, opts)
  return data
end

#get_speechandtextanalytics_conversation_communication_transcripturl(conversation_id, communication_id, opts = {}) ⇒ TranscriptUrl

Get the pre-signed S3 URL for the transcript of a specific communication of a conversation

Parameters:

  • conversation_id —

    Conversation ID

  • communication_id —

    Communication ID

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

    the optional parameters

Returns:



98
99
100
101
 
# File 'lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb', line 98

def get_speechandtextanalytics_conversation_communication_transcripturl(conversation_id, communication_id, opts = {})
  data, _status_code, _headers = get_speechandtextanalytics_conversation_communication_transcripturl_with_http_info(conversation_id, communication_id, opts)
  return data
end

#get_speechandtextanalytics_conversation_communication_transcripturl_with_http_info(conversation_id, communication_id, opts = {}) ⇒ Array<(TranscriptUrl, Fixnum, Hash)>

Get the pre-signed S3 URL for the transcript of a specific communication of a conversation

Parameters:

  • conversation_id —

    Conversation ID

  • communication_id —

    Communication ID

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

    the optional parameters

Returns:

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

    TranscriptUrl data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb', line 109

def get_speechandtextanalytics_conversation_communication_transcripturl_with_http_info(conversation_id, communication_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SpeechTextAnalyticsApi.get_speechandtextanalytics_conversation_communication_transcripturl ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling SpeechTextAnalyticsApi.get_speechandtextanalytics_conversation_communication_transcripturl" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'communication_id' is set
  fail ArgumentError, "Missing the required parameter 'communication_id' when calling SpeechTextAnalyticsApi.get_speechandtextanalytics_conversation_communication_transcripturl" if communication_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'communicationId' + '}', communication_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TranscriptUrl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SpeechTextAnalyticsApi#get_speechandtextanalytics_conversation_communication_transcripturl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_speechandtextanalytics_conversation_with_http_info(conversation_id, opts = {}) ⇒ Array<(ConversationMetrics, Fixnum, Hash)>

Get Speech and Text Analytics for a specific conversation

Parameters:

  • conversation_id —

    Conversation Id

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

    the optional parameters

Returns:

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

    ConversationMetrics data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb', line 42

def get_speechandtextanalytics_conversation_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SpeechTextAnalyticsApi.get_speechandtextanalytics_conversation ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling SpeechTextAnalyticsApi.get_speechandtextanalytics_conversation" if conversation_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/speechandtextanalytics/conversations/{conversationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationMetrics')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SpeechTextAnalyticsApi#get_speechandtextanalytics_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end