docs/SpeechTextAnalyticsApi.md in purecloudplatformclientv2-95.0.0 vs docs/SpeechTextAnalyticsApi.md in purecloudplatformclientv2-96.0.0

- old
+ new

@@ -6,11 +6,77 @@ All URIs are relative to *https://api.mypurecloud.com* Method | Description ------------- | ------------- | ------------- +[**get_speechandtextanalytics_conversation**](SpeechTextAnalyticsApi.html#get_speechandtextanalytics_conversation) | Get Speech and Text Analytics for a specific conversation [**get_speechandtextanalytics_conversation_communication_transcripturl**](SpeechTextAnalyticsApi.html#get_speechandtextanalytics_conversation_communication_transcripturl) | Get the pre-signed S3 URL for the transcript of a specific communication of a conversation {: class="table table-striped"} + +<a name="get_speechandtextanalytics_conversation"></a> + +## [**ConversationMetrics**](ConversationMetrics.html) get_speechandtextanalytics_conversation(conversation_id) + + + +Get Speech and Text Analytics for a specific conversation + + + +Wraps GET /api/v2/speechandtextanalytics/conversations/{conversationId} + +Requires ANY permissions: + +* recording:recording:view + + +### Example +```{"language":"ruby"} +# load the gem +require 'purecloudplatformclientv2' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::SpeechTextAnalyticsApi.new + +conversation_id = "conversation_id_example" # String | Conversation Id + + +begin + #Get Speech and Text Analytics for a specific conversation + result = api_instance.get_speechandtextanalytics_conversation(conversation_id) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_conversation: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **conversation_id** | **String**| Conversation Id | | +{: class="table table-striped"} + + +### Return type + +[**ConversationMetrics**](ConversationMetrics.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + <a name="get_speechandtextanalytics_conversation_communication_transcripturl"></a> ## [**TranscriptUrl**](TranscriptUrl.html) get_speechandtextanalytics_conversation_communication_transcripturl(conversation_id, communication_id)