cloudmersive-dlp-api-client 2.2.0 → 2.2.1

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 (80) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +30 -8
  3. data/docs/AudioTimestamp.md +12 -0
  4. data/docs/CustomPiiField.md +9 -0
  5. data/docs/DetectApi.md +114 -2
  6. data/docs/DlpAdvancedAudioDetectionRequest.md +48 -0
  7. data/docs/DlpAdvancedAudioDetectionResponse.md +48 -0
  8. data/docs/DlpAdvancedAudioRedactionRequest.md +54 -0
  9. data/docs/DlpAdvancedAudioRedactionResponse.md +51 -0
  10. data/docs/DlpAdvancedDetectionRequest.md +4 -0
  11. data/docs/DlpAdvancedDetectionResponse.md +3 -0
  12. data/docs/DlpAdvancedDocumentDetectionRequest.md +6 -2
  13. data/docs/DlpAdvancedDocumentRedactionRequest.md +7 -2
  14. data/docs/DlpAdvancedDocumentRedactionResponse.md +3 -0
  15. data/docs/DlpAdvancedRedactionRequest.md +6 -1
  16. data/docs/DlpAdvancedRedactionResponse.md +3 -0
  17. data/docs/DlpAudioDetectionRequest.md +32 -0
  18. data/docs/DlpAudioDetectionResponse.md +33 -0
  19. data/docs/DlpAudioRedactionRequest.md +35 -0
  20. data/docs/DlpAudioRedactionResponse.md +36 -0
  21. data/docs/DlpBatchJobResult.md +9 -0
  22. data/docs/DlpBatchJobStatusResult.md +15 -0
  23. data/docs/DlpDocumentDetectionRequest.md +2 -2
  24. data/docs/DlpDocumentRedactionRequest.md +2 -2
  25. data/docs/DlpRedactionRequest.md +1 -1
  26. data/docs/RedactApi.md +114 -2
  27. data/docs/RedactedAudioSegment.md +10 -0
  28. data/docs/TasksBatchJobApi.md +288 -0
  29. data/lib/cloudmersive-dlp-api-client/api/detect_api.rb +104 -4
  30. data/lib/cloudmersive-dlp-api-client/api/redact_api.rb +104 -4
  31. data/lib/cloudmersive-dlp-api-client/api/tasks_batch_job_api.rb +272 -0
  32. data/lib/cloudmersive-dlp-api-client/models/audio_timestamp.rb +226 -0
  33. data/lib/cloudmersive-dlp-api-client/models/custom_pii_field.rb +196 -0
  34. data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_audio_detection_request.rb +601 -0
  35. data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_audio_detection_response.rb +588 -0
  36. data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_audio_redaction_request.rb +663 -0
  37. data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_audio_redaction_response.rb +635 -0
  38. data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_detection_request.rb +44 -4
  39. data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_detection_response.rb +31 -1
  40. data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_document_detection_request.rb +46 -6
  41. data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_document_redaction_request.rb +58 -6
  42. data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_document_redaction_response.rb +31 -1
  43. data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_redaction_request.rb +57 -5
  44. data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_redaction_response.rb +31 -1
  45. data/lib/cloudmersive-dlp-api-client/models/dlp_audio_detection_request.rb +441 -0
  46. data/lib/cloudmersive-dlp-api-client/models/dlp_audio_detection_response.rb +438 -0
  47. data/lib/cloudmersive-dlp-api-client/models/dlp_audio_redaction_request.rb +471 -0
  48. data/lib/cloudmersive-dlp-api-client/models/dlp_audio_redaction_response.rb +485 -0
  49. data/lib/cloudmersive-dlp-api-client/models/dlp_batch_job_result.rb +196 -0
  50. data/lib/cloudmersive-dlp-api-client/models/dlp_batch_job_status_result.rb +252 -0
  51. data/lib/cloudmersive-dlp-api-client/models/dlp_document_detection_request.rb +2 -2
  52. data/lib/cloudmersive-dlp-api-client/models/dlp_document_redaction_request.rb +2 -2
  53. data/lib/cloudmersive-dlp-api-client/models/dlp_redaction_request.rb +1 -1
  54. data/lib/cloudmersive-dlp-api-client/models/redacted_audio_segment.rb +206 -0
  55. data/lib/cloudmersive-dlp-api-client/version.rb +1 -1
  56. data/lib/cloudmersive-dlp-api-client.rb +14 -0
  57. data/spec/api/detect_api_spec.rb +26 -2
  58. data/spec/api/redact_api_spec.rb +26 -2
  59. data/spec/api/tasks_batch_job_api_spec.rb +95 -0
  60. data/spec/models/audio_timestamp_spec.rb +65 -0
  61. data/spec/models/custom_pii_field_spec.rb +47 -0
  62. data/spec/models/dlp_advanced_audio_detection_request_spec.rb +281 -0
  63. data/spec/models/dlp_advanced_audio_detection_response_spec.rb +281 -0
  64. data/spec/models/dlp_advanced_audio_redaction_request_spec.rb +317 -0
  65. data/spec/models/dlp_advanced_audio_redaction_response_spec.rb +299 -0
  66. data/spec/models/dlp_advanced_detection_request_spec.rb +24 -0
  67. data/spec/models/dlp_advanced_detection_response_spec.rb +18 -0
  68. data/spec/models/dlp_advanced_document_detection_request_spec.rb +24 -0
  69. data/spec/models/dlp_advanced_document_redaction_request_spec.rb +30 -0
  70. data/spec/models/dlp_advanced_document_redaction_response_spec.rb +18 -0
  71. data/spec/models/dlp_advanced_redaction_request_spec.rb +30 -0
  72. data/spec/models/dlp_advanced_redaction_response_spec.rb +18 -0
  73. data/spec/models/dlp_audio_detection_request_spec.rb +185 -0
  74. data/spec/models/dlp_audio_detection_response_spec.rb +191 -0
  75. data/spec/models/dlp_audio_redaction_request_spec.rb +203 -0
  76. data/spec/models/dlp_audio_redaction_response_spec.rb +209 -0
  77. data/spec/models/dlp_batch_job_result_spec.rb +47 -0
  78. data/spec/models/dlp_batch_job_status_result_spec.rb +83 -0
  79. data/spec/models/redacted_audio_segment_spec.rb +53 -0
  80. metadata +44 -2
@@ -0,0 +1,288 @@
1
+ # CloudmersiveDlpApiClient::TasksBatchJobApi
2
+
3
+ All URIs are relative to *https://localhost*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**detect_audio_advanced_batch_job**](TasksBatchJobApi.md#detect_audio_advanced_batch_job) | **POST** /dlp/batch-job/detect/audio/advanced | Detect User Data in Audio File (Advanced) as a Batch Job
8
+ [**detect_audio_batch_job**](TasksBatchJobApi.md#detect_audio_batch_job) | **POST** /dlp/batch-job/detect/audio | Detect User Data in Audio File as a Batch Job
9
+ [**get_async_job_status**](TasksBatchJobApi.md#get_async_job_status) | **GET** /dlp/batch-job/status | Get the status and result of a DLP Batch Job
10
+ [**redact_audio_advanced_batch_job**](TasksBatchJobApi.md#redact_audio_advanced_batch_job) | **POST** /dlp/batch-job/redact/audio/advanced | Redact User Data in Audio File (Advanced) as a Batch Job
11
+ [**redact_audio_batch_job**](TasksBatchJobApi.md#redact_audio_batch_job) | **POST** /dlp/batch-job/redact/audio | Redact User Data in Audio File as a Batch Job
12
+
13
+
14
+ # **detect_audio_advanced_batch_job**
15
+ > DlpBatchJobResult detect_audio_advanced_batch_job(opts)
16
+
17
+ Detect User Data in Audio File (Advanced) as a Batch Job
18
+
19
+ Creates an async batch job for detecting user data in an audio file using Advanced detection. Use the GetAsyncJobStatus API to check on the status of the job and retrieve the result when complete. Transcribes an audio file (WAV, MP3, M4A, FLAC, OGG, WMA) and detects 29 configurable types of user data including health-related PHI in the transcript using Advanced AI. Returns the full transcript, token timestamps, detection results, and optional rationale. Requires Managed Instance or Private Cloud deployment.
20
+
21
+ ### Example
22
+ ```ruby
23
+ # load the gem
24
+ require 'cloudmersive-dlp-api-client'
25
+ # setup authorization
26
+ CloudmersiveDlpApiClient.configure do |config|
27
+ # Configure API key authorization: Apikey
28
+ config.api_key['Apikey'] = 'YOUR API KEY'
29
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
+ #config.api_key_prefix['Apikey'] = 'Bearer'
31
+ end
32
+
33
+ api_instance = CloudmersiveDlpApiClient::TasksBatchJobApi.new
34
+
35
+ opts = {
36
+ body: CloudmersiveDlpApiClient::DlpAdvancedAudioDetectionRequest.new # DlpAdvancedAudioDetectionRequest | Input request
37
+ }
38
+
39
+ begin
40
+ #Detect User Data in Audio File (Advanced) as a Batch Job
41
+ result = api_instance.detect_audio_advanced_batch_job(opts)
42
+ p result
43
+ rescue CloudmersiveDlpApiClient::ApiError => e
44
+ puts "Exception when calling TasksBatchJobApi->detect_audio_advanced_batch_job: #{e}"
45
+ end
46
+ ```
47
+
48
+ ### Parameters
49
+
50
+ Name | Type | Description | Notes
51
+ ------------- | ------------- | ------------- | -------------
52
+ **body** | [**DlpAdvancedAudioDetectionRequest**](DlpAdvancedAudioDetectionRequest.md)| Input request | [optional]
53
+
54
+ ### Return type
55
+
56
+ [**DlpBatchJobResult**](DlpBatchJobResult.md)
57
+
58
+ ### Authorization
59
+
60
+ [Apikey](../README.md#Apikey)
61
+
62
+ ### HTTP request headers
63
+
64
+ - **Content-Type**: application/json, text/json, application/*+json
65
+ - **Accept**: text/plain, application/json, text/json
66
+
67
+
68
+
69
+ # **detect_audio_batch_job**
70
+ > DlpBatchJobResult detect_audio_batch_job(opts)
71
+
72
+ Detect User Data in Audio File as a Batch Job
73
+
74
+ Creates an async batch job for detecting user data in an audio file. Use the GetAsyncJobStatus API to check on the status of the job and retrieve the result when complete. Transcribes an audio file (WAV, MP3, M4A, FLAC, OGG, WMA) and detects 23 configurable types of user data in the transcript using Advanced AI. Returns the full transcript, token timestamps, and detection results. Requires Managed Instance or Private Cloud deployment.
75
+
76
+ ### Example
77
+ ```ruby
78
+ # load the gem
79
+ require 'cloudmersive-dlp-api-client'
80
+ # setup authorization
81
+ CloudmersiveDlpApiClient.configure do |config|
82
+ # Configure API key authorization: Apikey
83
+ config.api_key['Apikey'] = 'YOUR API KEY'
84
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
85
+ #config.api_key_prefix['Apikey'] = 'Bearer'
86
+ end
87
+
88
+ api_instance = CloudmersiveDlpApiClient::TasksBatchJobApi.new
89
+
90
+ opts = {
91
+ body: CloudmersiveDlpApiClient::DlpAudioDetectionRequest.new # DlpAudioDetectionRequest | Input request
92
+ }
93
+
94
+ begin
95
+ #Detect User Data in Audio File as a Batch Job
96
+ result = api_instance.detect_audio_batch_job(opts)
97
+ p result
98
+ rescue CloudmersiveDlpApiClient::ApiError => e
99
+ puts "Exception when calling TasksBatchJobApi->detect_audio_batch_job: #{e}"
100
+ end
101
+ ```
102
+
103
+ ### Parameters
104
+
105
+ Name | Type | Description | Notes
106
+ ------------- | ------------- | ------------- | -------------
107
+ **body** | [**DlpAudioDetectionRequest**](DlpAudioDetectionRequest.md)| Input request | [optional]
108
+
109
+ ### Return type
110
+
111
+ [**DlpBatchJobResult**](DlpBatchJobResult.md)
112
+
113
+ ### Authorization
114
+
115
+ [Apikey](../README.md#Apikey)
116
+
117
+ ### HTTP request headers
118
+
119
+ - **Content-Type**: application/json, text/json, application/*+json
120
+ - **Accept**: text/plain, application/json, text/json
121
+
122
+
123
+
124
+ # **get_async_job_status**
125
+ > DlpBatchJobStatusResult get_async_job_status(opts)
126
+
127
+ Get the status and result of a DLP Batch Job
128
+
129
+ Returns the result of the Async Job - possible states can be STARTED or COMPLETED. When COMPLETED, the corresponding result field (detection or redaction result) is populated on the response. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.
130
+
131
+ ### Example
132
+ ```ruby
133
+ # load the gem
134
+ require 'cloudmersive-dlp-api-client'
135
+ # setup authorization
136
+ CloudmersiveDlpApiClient.configure do |config|
137
+ # Configure API key authorization: Apikey
138
+ config.api_key['Apikey'] = 'YOUR API KEY'
139
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
140
+ #config.api_key_prefix['Apikey'] = 'Bearer'
141
+ end
142
+
143
+ api_instance = CloudmersiveDlpApiClient::TasksBatchJobApi.new
144
+
145
+ opts = {
146
+ async_job_id: 'async_job_id_example' # String | Job ID for the batch job to get the status of
147
+ }
148
+
149
+ begin
150
+ #Get the status and result of a DLP Batch Job
151
+ result = api_instance.get_async_job_status(opts)
152
+ p result
153
+ rescue CloudmersiveDlpApiClient::ApiError => e
154
+ puts "Exception when calling TasksBatchJobApi->get_async_job_status: #{e}"
155
+ end
156
+ ```
157
+
158
+ ### Parameters
159
+
160
+ Name | Type | Description | Notes
161
+ ------------- | ------------- | ------------- | -------------
162
+ **async_job_id** | **String**| Job ID for the batch job to get the status of | [optional]
163
+
164
+ ### Return type
165
+
166
+ [**DlpBatchJobStatusResult**](DlpBatchJobStatusResult.md)
167
+
168
+ ### Authorization
169
+
170
+ [Apikey](../README.md#Apikey)
171
+
172
+ ### HTTP request headers
173
+
174
+ - **Content-Type**: Not defined
175
+ - **Accept**: text/plain, application/json, text/json
176
+
177
+
178
+
179
+ # **redact_audio_advanced_batch_job**
180
+ > DlpBatchJobResult redact_audio_advanced_batch_job(opts)
181
+
182
+ Redact User Data in Audio File (Advanced) as a Batch Job
183
+
184
+ Creates an async batch job for redacting user data in an audio file using Advanced detection. Use the GetAsyncJobStatus API to check on the status of the job and retrieve the redacted audio and transcript when complete. Transcribes an audio file (WAV, MP3, M4A, FLAC, OGG, WMA), detects 34 configurable types of user data including health-related PHI in the transcript, and redacts audio segments containing PII. Returns the redacted audio, redacted transcript, detection results, redacted segment timestamps, and optional rationale. Requires Managed Instance or Private Cloud deployment.
185
+
186
+ ### Example
187
+ ```ruby
188
+ # load the gem
189
+ require 'cloudmersive-dlp-api-client'
190
+ # setup authorization
191
+ CloudmersiveDlpApiClient.configure do |config|
192
+ # Configure API key authorization: Apikey
193
+ config.api_key['Apikey'] = 'YOUR API KEY'
194
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
195
+ #config.api_key_prefix['Apikey'] = 'Bearer'
196
+ end
197
+
198
+ api_instance = CloudmersiveDlpApiClient::TasksBatchJobApi.new
199
+
200
+ opts = {
201
+ body: CloudmersiveDlpApiClient::DlpAdvancedAudioRedactionRequest.new # DlpAdvancedAudioRedactionRequest | Input request
202
+ }
203
+
204
+ begin
205
+ #Redact User Data in Audio File (Advanced) as a Batch Job
206
+ result = api_instance.redact_audio_advanced_batch_job(opts)
207
+ p result
208
+ rescue CloudmersiveDlpApiClient::ApiError => e
209
+ puts "Exception when calling TasksBatchJobApi->redact_audio_advanced_batch_job: #{e}"
210
+ end
211
+ ```
212
+
213
+ ### Parameters
214
+
215
+ Name | Type | Description | Notes
216
+ ------------- | ------------- | ------------- | -------------
217
+ **body** | [**DlpAdvancedAudioRedactionRequest**](DlpAdvancedAudioRedactionRequest.md)| Input request | [optional]
218
+
219
+ ### Return type
220
+
221
+ [**DlpBatchJobResult**](DlpBatchJobResult.md)
222
+
223
+ ### Authorization
224
+
225
+ [Apikey](../README.md#Apikey)
226
+
227
+ ### HTTP request headers
228
+
229
+ - **Content-Type**: application/json, text/json, application/*+json
230
+ - **Accept**: text/plain, application/json, text/json
231
+
232
+
233
+
234
+ # **redact_audio_batch_job**
235
+ > DlpBatchJobResult redact_audio_batch_job(opts)
236
+
237
+ Redact User Data in Audio File as a Batch Job
238
+
239
+ Creates an async batch job for redacting user data in an audio file. Use the GetAsyncJobStatus API to check on the status of the job and retrieve the redacted audio and transcript when complete. Transcribes an audio file (WAV, MP3, M4A, FLAC, OGG, WMA), detects 23 configurable types of user data in the transcript, and redacts audio segments containing PII. Returns the redacted audio, redacted transcript, detection results, and redacted segment timestamps. Requires Managed Instance or Private Cloud deployment.
240
+
241
+ ### Example
242
+ ```ruby
243
+ # load the gem
244
+ require 'cloudmersive-dlp-api-client'
245
+ # setup authorization
246
+ CloudmersiveDlpApiClient.configure do |config|
247
+ # Configure API key authorization: Apikey
248
+ config.api_key['Apikey'] = 'YOUR API KEY'
249
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
250
+ #config.api_key_prefix['Apikey'] = 'Bearer'
251
+ end
252
+
253
+ api_instance = CloudmersiveDlpApiClient::TasksBatchJobApi.new
254
+
255
+ opts = {
256
+ body: CloudmersiveDlpApiClient::DlpAudioRedactionRequest.new # DlpAudioRedactionRequest | Input request
257
+ }
258
+
259
+ begin
260
+ #Redact User Data in Audio File as a Batch Job
261
+ result = api_instance.redact_audio_batch_job(opts)
262
+ p result
263
+ rescue CloudmersiveDlpApiClient::ApiError => e
264
+ puts "Exception when calling TasksBatchJobApi->redact_audio_batch_job: #{e}"
265
+ end
266
+ ```
267
+
268
+ ### Parameters
269
+
270
+ Name | Type | Description | Notes
271
+ ------------- | ------------- | ------------- | -------------
272
+ **body** | [**DlpAudioRedactionRequest**](DlpAudioRedactionRequest.md)| Input request | [optional]
273
+
274
+ ### Return type
275
+
276
+ [**DlpBatchJobResult**](DlpBatchJobResult.md)
277
+
278
+ ### Authorization
279
+
280
+ [Apikey](../README.md#Apikey)
281
+
282
+ ### HTTP request headers
283
+
284
+ - **Content-Type**: application/json, text/json, application/*+json
285
+ - **Accept**: text/plain, application/json, text/json
286
+
287
+
288
+
@@ -19,8 +19,108 @@ module CloudmersiveDlpApiClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Detect User Data in Audio File
23
+ # Transcribes an audio file (WAV, MP3, M4A, FLAC, OGG, WMA) and detects 23 configurable types of user data in the transcript using Advanced AI. Returns the full transcript, token timestamps, and detection results.
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [DlpAudioDetectionRequest] :body Input request
26
+ # @return [DlpAudioDetectionResponse]
27
+ def detect_audio(opts = {})
28
+ data, _status_code, _headers = detect_audio_with_http_info(opts)
29
+ data
30
+ end
31
+
32
+ # Detect User Data in Audio File
33
+ # Transcribes an audio file (WAV, MP3, M4A, FLAC, OGG, WMA) and detects 23 configurable types of user data in the transcript using Advanced AI. Returns the full transcript, token timestamps, and detection results.
34
+ # @param [Hash] opts the optional parameters
35
+ # @option opts [DlpAudioDetectionRequest] :body Input request
36
+ # @return [Array<(DlpAudioDetectionResponse, Fixnum, Hash)>] DlpAudioDetectionResponse data, response status code and response headers
37
+ def detect_audio_with_http_info(opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: DetectApi.detect_audio ...'
40
+ end
41
+ # resource path
42
+ local_var_path = '/dlp/detect/audio'
43
+
44
+ # query parameters
45
+ query_params = {}
46
+
47
+ # header parameters
48
+ header_params = {}
49
+ # HTTP header 'Accept' (if needed)
50
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
51
+ # HTTP header 'Content-Type'
52
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
53
+
54
+ # form parameters
55
+ form_params = {}
56
+
57
+ # http body (model)
58
+ post_body = @api_client.object_to_http_body(opts[:'body'])
59
+ auth_names = ['Apikey']
60
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
61
+ :header_params => header_params,
62
+ :query_params => query_params,
63
+ :form_params => form_params,
64
+ :body => post_body,
65
+ :auth_names => auth_names,
66
+ :return_type => 'DlpAudioDetectionResponse')
67
+ if @api_client.config.debugging
68
+ @api_client.config.logger.debug "API called: DetectApi#detect_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
69
+ end
70
+ return data, status_code, headers
71
+ end
72
+ # Detect User Data in Audio File (Advanced)
73
+ # Transcribes an audio file (WAV, MP3, M4A, FLAC, OGG, WMA) and detects 29 configurable types of user data including health-related PHI in the transcript using Advanced AI. Returns the full transcript, token timestamps, detection results, and optional rationale.
74
+ # @param [Hash] opts the optional parameters
75
+ # @option opts [DlpAdvancedAudioDetectionRequest] :body Input request
76
+ # @return [DlpAdvancedAudioDetectionResponse]
77
+ def detect_audio_advanced(opts = {})
78
+ data, _status_code, _headers = detect_audio_advanced_with_http_info(opts)
79
+ data
80
+ end
81
+
82
+ # Detect User Data in Audio File (Advanced)
83
+ # Transcribes an audio file (WAV, MP3, M4A, FLAC, OGG, WMA) and detects 29 configurable types of user data including health-related PHI in the transcript using Advanced AI. Returns the full transcript, token timestamps, detection results, and optional rationale.
84
+ # @param [Hash] opts the optional parameters
85
+ # @option opts [DlpAdvancedAudioDetectionRequest] :body Input request
86
+ # @return [Array<(DlpAdvancedAudioDetectionResponse, Fixnum, Hash)>] DlpAdvancedAudioDetectionResponse data, response status code and response headers
87
+ def detect_audio_advanced_with_http_info(opts = {})
88
+ if @api_client.config.debugging
89
+ @api_client.config.logger.debug 'Calling API: DetectApi.detect_audio_advanced ...'
90
+ end
91
+ # resource path
92
+ local_var_path = '/dlp/detect/audio/advanced'
93
+
94
+ # query parameters
95
+ query_params = {}
96
+
97
+ # header parameters
98
+ header_params = {}
99
+ # HTTP header 'Accept' (if needed)
100
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
101
+ # HTTP header 'Content-Type'
102
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
103
+
104
+ # form parameters
105
+ form_params = {}
106
+
107
+ # http body (model)
108
+ post_body = @api_client.object_to_http_body(opts[:'body'])
109
+ auth_names = ['Apikey']
110
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
111
+ :header_params => header_params,
112
+ :query_params => query_params,
113
+ :form_params => form_params,
114
+ :body => post_body,
115
+ :auth_names => auth_names,
116
+ :return_type => 'DlpAdvancedAudioDetectionResponse')
117
+ if @api_client.config.debugging
118
+ @api_client.config.logger.debug "API called: DetectApi#detect_audio_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
119
+ end
120
+ return data, status_code, headers
121
+ end
22
122
  # Detect User Data in Document Image
23
- # Detects configurable types of user data in a document image (PDF, DOCX, PNG, JPG) using Advanced AI.
123
+ # Detects configurable types of user data in a document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) using Advanced AI.
24
124
  # @param [Hash] opts the optional parameters
25
125
  # @option opts [DlpDocumentDetectionRequest] :body Input request
26
126
  # @return [DlpDetectionResponse]
@@ -30,7 +130,7 @@ module CloudmersiveDlpApiClient
30
130
  end
31
131
 
32
132
  # Detect User Data in Document Image
33
- # Detects configurable types of user data in a document image (PDF, DOCX, PNG, JPG) using Advanced AI.
133
+ # Detects configurable types of user data in a document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) using Advanced AI.
34
134
  # @param [Hash] opts the optional parameters
35
135
  # @option opts [DlpDocumentDetectionRequest] :body Input request
36
136
  # @return [Array<(DlpDetectionResponse, Fixnum, Hash)>] DlpDetectionResponse data, response status code and response headers
@@ -70,7 +170,7 @@ module CloudmersiveDlpApiClient
70
170
  return data, status_code, headers
71
171
  end
72
172
  # Detect User Data in Document Image (Advanced)
73
- # Detects 29 configurable types of user data including health-related PHI in a document image (PDF, DOCX, PNG, JPG) using Advanced AI.
173
+ # Detects 29 configurable types of user data including health-related PHI in a document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) using Advanced AI.
74
174
  # @param [Hash] opts the optional parameters
75
175
  # @option opts [DlpAdvancedDocumentDetectionRequest] :body Input request
76
176
  # @return [DlpAdvancedDetectionResponse]
@@ -80,7 +180,7 @@ module CloudmersiveDlpApiClient
80
180
  end
81
181
 
82
182
  # Detect User Data in Document Image (Advanced)
83
- # Detects 29 configurable types of user data including health-related PHI in a document image (PDF, DOCX, PNG, JPG) using Advanced AI.
183
+ # Detects 29 configurable types of user data including health-related PHI in a document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) using Advanced AI.
84
184
  # @param [Hash] opts the optional parameters
85
185
  # @option opts [DlpAdvancedDocumentDetectionRequest] :body Input request
86
186
  # @return [Array<(DlpAdvancedDetectionResponse, Fixnum, Hash)>] DlpAdvancedDetectionResponse data, response status code and response headers
@@ -19,8 +19,108 @@ module CloudmersiveDlpApiClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Redact User Data in Audio File
23
+ # Transcribes an audio file (WAV, MP3, M4A, FLAC, OGG, WMA), detects 23 configurable types of user data in the transcript, and redacts audio segments containing PII. Returns the redacted audio, redacted transcript, detection results, and redacted segment timestamps.
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [DlpAudioRedactionRequest] :body Input request
26
+ # @return [DlpAudioRedactionResponse]
27
+ def redact_audio(opts = {})
28
+ data, _status_code, _headers = redact_audio_with_http_info(opts)
29
+ data
30
+ end
31
+
32
+ # Redact User Data in Audio File
33
+ # Transcribes an audio file (WAV, MP3, M4A, FLAC, OGG, WMA), detects 23 configurable types of user data in the transcript, and redacts audio segments containing PII. Returns the redacted audio, redacted transcript, detection results, and redacted segment timestamps.
34
+ # @param [Hash] opts the optional parameters
35
+ # @option opts [DlpAudioRedactionRequest] :body Input request
36
+ # @return [Array<(DlpAudioRedactionResponse, Fixnum, Hash)>] DlpAudioRedactionResponse data, response status code and response headers
37
+ def redact_audio_with_http_info(opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: RedactApi.redact_audio ...'
40
+ end
41
+ # resource path
42
+ local_var_path = '/dlp/redact/audio'
43
+
44
+ # query parameters
45
+ query_params = {}
46
+
47
+ # header parameters
48
+ header_params = {}
49
+ # HTTP header 'Accept' (if needed)
50
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
51
+ # HTTP header 'Content-Type'
52
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
53
+
54
+ # form parameters
55
+ form_params = {}
56
+
57
+ # http body (model)
58
+ post_body = @api_client.object_to_http_body(opts[:'body'])
59
+ auth_names = ['Apikey']
60
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
61
+ :header_params => header_params,
62
+ :query_params => query_params,
63
+ :form_params => form_params,
64
+ :body => post_body,
65
+ :auth_names => auth_names,
66
+ :return_type => 'DlpAudioRedactionResponse')
67
+ if @api_client.config.debugging
68
+ @api_client.config.logger.debug "API called: RedactApi#redact_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
69
+ end
70
+ return data, status_code, headers
71
+ end
72
+ # Redact User Data in Audio File (Advanced)
73
+ # Transcribes an audio file (WAV, MP3, M4A, FLAC, OGG, WMA), detects 34 configurable types of user data including health-related PHI in the transcript, and redacts audio segments containing PII. Returns the redacted audio, redacted transcript, detection results, redacted segment timestamps, and optional rationale.
74
+ # @param [Hash] opts the optional parameters
75
+ # @option opts [DlpAdvancedAudioRedactionRequest] :body Input request
76
+ # @return [DlpAdvancedAudioRedactionResponse]
77
+ def redact_audio_advanced(opts = {})
78
+ data, _status_code, _headers = redact_audio_advanced_with_http_info(opts)
79
+ data
80
+ end
81
+
82
+ # Redact User Data in Audio File (Advanced)
83
+ # Transcribes an audio file (WAV, MP3, M4A, FLAC, OGG, WMA), detects 34 configurable types of user data including health-related PHI in the transcript, and redacts audio segments containing PII. Returns the redacted audio, redacted transcript, detection results, redacted segment timestamps, and optional rationale.
84
+ # @param [Hash] opts the optional parameters
85
+ # @option opts [DlpAdvancedAudioRedactionRequest] :body Input request
86
+ # @return [Array<(DlpAdvancedAudioRedactionResponse, Fixnum, Hash)>] DlpAdvancedAudioRedactionResponse data, response status code and response headers
87
+ def redact_audio_advanced_with_http_info(opts = {})
88
+ if @api_client.config.debugging
89
+ @api_client.config.logger.debug 'Calling API: RedactApi.redact_audio_advanced ...'
90
+ end
91
+ # resource path
92
+ local_var_path = '/dlp/redact/audio/advanced'
93
+
94
+ # query parameters
95
+ query_params = {}
96
+
97
+ # header parameters
98
+ header_params = {}
99
+ # HTTP header 'Accept' (if needed)
100
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
101
+ # HTTP header 'Content-Type'
102
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
103
+
104
+ # form parameters
105
+ form_params = {}
106
+
107
+ # http body (model)
108
+ post_body = @api_client.object_to_http_body(opts[:'body'])
109
+ auth_names = ['Apikey']
110
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
111
+ :header_params => header_params,
112
+ :query_params => query_params,
113
+ :form_params => form_params,
114
+ :body => post_body,
115
+ :auth_names => auth_names,
116
+ :return_type => 'DlpAdvancedAudioRedactionResponse')
117
+ if @api_client.config.debugging
118
+ @api_client.config.logger.debug "API called: RedactApi#redact_audio_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
119
+ end
120
+ return data, status_code, headers
121
+ end
22
122
  # Redact User Data in Document
23
- # Detects and redacts configurable types of user data in a document (PDF, DOCX, PNG, JPG) using Advanced AI. Rasterizes document pages, detects PII regions using a grid-overlay approach, blurs those regions, and returns a rasterized PDF.
123
+ # Detects and redacts configurable types of user data in a document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) using Advanced AI. Rasterizes document pages, detects PII regions using a grid-overlay approach, blurs those regions, and returns a rasterized PDF.
24
124
  # @param [Hash] opts the optional parameters
25
125
  # @option opts [DlpDocumentRedactionRequest] :body Input request
26
126
  # @return [DlpDocumentRedactionResponse]
@@ -30,7 +130,7 @@ module CloudmersiveDlpApiClient
30
130
  end
31
131
 
32
132
  # Redact User Data in Document
33
- # Detects and redacts configurable types of user data in a document (PDF, DOCX, PNG, JPG) using Advanced AI. Rasterizes document pages, detects PII regions using a grid-overlay approach, blurs those regions, and returns a rasterized PDF.
133
+ # Detects and redacts configurable types of user data in a document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) using Advanced AI. Rasterizes document pages, detects PII regions using a grid-overlay approach, blurs those regions, and returns a rasterized PDF.
34
134
  # @param [Hash] opts the optional parameters
35
135
  # @option opts [DlpDocumentRedactionRequest] :body Input request
36
136
  # @return [Array<(DlpDocumentRedactionResponse, Fixnum, Hash)>] DlpDocumentRedactionResponse data, response status code and response headers
@@ -70,7 +170,7 @@ module CloudmersiveDlpApiClient
70
170
  return data, status_code, headers
71
171
  end
72
172
  # Redact User Data in Document (Advanced)
73
- # Detects and redacts 35 configurable types of user data including health-related PHI in a document (PDF, DOCX, PNG, JPG) using Advanced AI. Rasterizes document pages, detects PII regions using a row-overlay approach, redacts those regions, and returns a rasterized PDF.
173
+ # Detects and redacts 35 configurable types of user data including health-related PHI in a document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) using Advanced AI. Rasterizes document pages, detects PII regions using a row-overlay approach, redacts those regions, and returns a rasterized PDF.
74
174
  # @param [Hash] opts the optional parameters
75
175
  # @option opts [DlpAdvancedDocumentRedactionRequest] :body Input request
76
176
  # @return [DlpAdvancedDocumentRedactionResponse]
@@ -80,7 +180,7 @@ module CloudmersiveDlpApiClient
80
180
  end
81
181
 
82
182
  # Redact User Data in Document (Advanced)
83
- # Detects and redacts 35 configurable types of user data including health-related PHI in a document (PDF, DOCX, PNG, JPG) using Advanced AI. Rasterizes document pages, detects PII regions using a row-overlay approach, redacts those regions, and returns a rasterized PDF.
183
+ # Detects and redacts 35 configurable types of user data including health-related PHI in a document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) using Advanced AI. Rasterizes document pages, detects PII regions using a row-overlay approach, redacts those regions, and returns a rasterized PDF.
84
184
  # @param [Hash] opts the optional parameters
85
185
  # @option opts [DlpAdvancedDocumentRedactionRequest] :body Input request
86
186
  # @return [Array<(DlpAdvancedDocumentRedactionResponse, Fixnum, Hash)>] DlpAdvancedDocumentRedactionResponse data, response status code and response headers