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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c2c3cd63b4bcd9a040547d2e0192b2bcabbfa974a968b11cd95168a0b108ff93
4
- data.tar.gz: 4bcae80507c0dc6021fac639147affe1d305a14a3ba4b29ebdd02440161f694e
3
+ metadata.gz: a182ee01687157573095438566212f5f449c856f1f49f0cf209658774d0e6129
4
+ data.tar.gz: 4c1e0b4a120434dd75d887ec56fdcfadce1c5bb5c038c9dca9990f9c2fce2e1b
5
5
  SHA512:
6
- metadata.gz: 60b0d96c63c0c88bbb964ccc26f95deffd8bd77373bf35846c20c6738984582a3c395bd8fba04c36501f2a66e11bf76567c9ec6b32a44dc4ea47460f230ced9b
7
- data.tar.gz: 63f4b9019c2b4bceb901125f6271279e5d5e4fb6d832cb7b2f7e336f87ddc1e16aa337e5b5182d6efbb437c7ac1d9ea1343d2afbe40c982dd468f73e3a22f459
6
+ metadata.gz: 2f2b60b1707664b23e3c446b6ccd7db03ac50ddb35a85427c213ffa736ec9beec7b500f41f4ebcfb74871dd11ae84617c4c34204752d4573ba1c17c7cd8011e1
7
+ data.tar.gz: a0305ce8c599f93674a0cae8bbeff256c18827bcf0a205a07bfcd2d38ce9bcd84f0089aa09300f43f236c494a3fb1be72bc2f4ddf319886529e5128292e1d02e
data/README.md CHANGED
@@ -7,7 +7,7 @@ Easily and directly scan and detect sensitive data (PII) in input text.
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: v1
10
- - Package version: 2.2.0
10
+ - Package version: 2.2.1
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-dlp-api-client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./cloudmersive-dlp-api-client-2.2.0.gem
26
+ gem install ./cloudmersive-dlp-api-client-2.2.1.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-dlp-api-client-2.2.0.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-dlp-api-client-2.2.1.gem` to install the development dependencies)
29
29
 
30
30
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
31
 
32
32
  Finally add this to the Gemfile:
33
33
 
34
- gem 'cloudmersive-dlp-api-client', '~> 2.2.0'
34
+ gem 'cloudmersive-dlp-api-client', '~> 2.2.1'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -65,15 +65,15 @@ end
65
65
  api_instance = CloudmersiveDlpApiClient::DetectApi.new
66
66
 
67
67
  opts = {
68
- body: CloudmersiveDlpApiClient::DlpDocumentDetectionRequest.new # DlpDocumentDetectionRequest | Input request
68
+ body: CloudmersiveDlpApiClient::DlpAudioDetectionRequest.new # DlpAudioDetectionRequest | Input request
69
69
  }
70
70
 
71
71
  begin
72
- #Detect User Data in Document Image
73
- result = api_instance.detect_document(opts)
72
+ #Detect User Data in Audio File
73
+ result = api_instance.detect_audio(opts)
74
74
  p result
75
75
  rescue CloudmersiveDlpApiClient::ApiError => e
76
- puts "Exception when calling DetectApi->detect_document: #{e}"
76
+ puts "Exception when calling DetectApi->detect_audio: #{e}"
77
77
  end
78
78
 
79
79
  ```
@@ -84,18 +84,33 @@ All URIs are relative to *https://localhost*
84
84
 
85
85
  Class | Method | HTTP request | Description
86
86
  ------------ | ------------- | ------------- | -------------
87
+ *CloudmersiveDlpApiClient::DetectApi* | [**detect_audio**](docs/DetectApi.md#detect_audio) | **POST** /dlp/detect/audio | Detect User Data in Audio File
88
+ *CloudmersiveDlpApiClient::DetectApi* | [**detect_audio_advanced**](docs/DetectApi.md#detect_audio_advanced) | **POST** /dlp/detect/audio/advanced | Detect User Data in Audio File (Advanced)
87
89
  *CloudmersiveDlpApiClient::DetectApi* | [**detect_document**](docs/DetectApi.md#detect_document) | **POST** /dlp/detect/document | Detect User Data in Document Image
88
90
  *CloudmersiveDlpApiClient::DetectApi* | [**detect_document_advanced**](docs/DetectApi.md#detect_document_advanced) | **POST** /dlp/detect/document/advanced | Detect User Data in Document Image (Advanced)
89
91
  *CloudmersiveDlpApiClient::DetectApi* | [**detect_text**](docs/DetectApi.md#detect_text) | **POST** /dlp/detect/text | Detect User Data in Input Text
90
92
  *CloudmersiveDlpApiClient::DetectApi* | [**detect_text_advanced**](docs/DetectApi.md#detect_text_advanced) | **POST** /dlp/detect/text/advanced | Detect User Data in Input Text (Advanced)
93
+ *CloudmersiveDlpApiClient::RedactApi* | [**redact_audio**](docs/RedactApi.md#redact_audio) | **POST** /dlp/redact/audio | Redact User Data in Audio File
94
+ *CloudmersiveDlpApiClient::RedactApi* | [**redact_audio_advanced**](docs/RedactApi.md#redact_audio_advanced) | **POST** /dlp/redact/audio/advanced | Redact User Data in Audio File (Advanced)
91
95
  *CloudmersiveDlpApiClient::RedactApi* | [**redact_document**](docs/RedactApi.md#redact_document) | **POST** /dlp/redact/document | Redact User Data in Document
92
96
  *CloudmersiveDlpApiClient::RedactApi* | [**redact_document_advanced**](docs/RedactApi.md#redact_document_advanced) | **POST** /dlp/redact/document/advanced | Redact User Data in Document (Advanced)
93
97
  *CloudmersiveDlpApiClient::RedactApi* | [**redact_text**](docs/RedactApi.md#redact_text) | **POST** /dlp/redact/text | Redact User Data in Input Text
94
98
  *CloudmersiveDlpApiClient::RedactApi* | [**redact_text_advanced**](docs/RedactApi.md#redact_text_advanced) | **POST** /dlp/redact/text/advanced | Redact User Data in Input Text (Advanced)
99
+ *CloudmersiveDlpApiClient::TasksBatchJobApi* | [**detect_audio_advanced_batch_job**](docs/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
100
+ *CloudmersiveDlpApiClient::TasksBatchJobApi* | [**detect_audio_batch_job**](docs/TasksBatchJobApi.md#detect_audio_batch_job) | **POST** /dlp/batch-job/detect/audio | Detect User Data in Audio File as a Batch Job
101
+ *CloudmersiveDlpApiClient::TasksBatchJobApi* | [**get_async_job_status**](docs/TasksBatchJobApi.md#get_async_job_status) | **GET** /dlp/batch-job/status | Get the status and result of a DLP Batch Job
102
+ *CloudmersiveDlpApiClient::TasksBatchJobApi* | [**redact_audio_advanced_batch_job**](docs/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
103
+ *CloudmersiveDlpApiClient::TasksBatchJobApi* | [**redact_audio_batch_job**](docs/TasksBatchJobApi.md#redact_audio_batch_job) | **POST** /dlp/batch-job/redact/audio | Redact User Data in Audio File as a Batch Job
95
104
 
96
105
 
97
106
  ## Documentation for Models
98
107
 
108
+ - [CloudmersiveDlpApiClient::AudioTimestamp](docs/AudioTimestamp.md)
109
+ - [CloudmersiveDlpApiClient::CustomPiiField](docs/CustomPiiField.md)
110
+ - [CloudmersiveDlpApiClient::DlpAdvancedAudioDetectionRequest](docs/DlpAdvancedAudioDetectionRequest.md)
111
+ - [CloudmersiveDlpApiClient::DlpAdvancedAudioDetectionResponse](docs/DlpAdvancedAudioDetectionResponse.md)
112
+ - [CloudmersiveDlpApiClient::DlpAdvancedAudioRedactionRequest](docs/DlpAdvancedAudioRedactionRequest.md)
113
+ - [CloudmersiveDlpApiClient::DlpAdvancedAudioRedactionResponse](docs/DlpAdvancedAudioRedactionResponse.md)
99
114
  - [CloudmersiveDlpApiClient::DlpAdvancedDetectionRequest](docs/DlpAdvancedDetectionRequest.md)
100
115
  - [CloudmersiveDlpApiClient::DlpAdvancedDetectionResponse](docs/DlpAdvancedDetectionResponse.md)
101
116
  - [CloudmersiveDlpApiClient::DlpAdvancedDocumentDetectionRequest](docs/DlpAdvancedDocumentDetectionRequest.md)
@@ -103,6 +118,12 @@ Class | Method | HTTP request | Description
103
118
  - [CloudmersiveDlpApiClient::DlpAdvancedDocumentRedactionResponse](docs/DlpAdvancedDocumentRedactionResponse.md)
104
119
  - [CloudmersiveDlpApiClient::DlpAdvancedRedactionRequest](docs/DlpAdvancedRedactionRequest.md)
105
120
  - [CloudmersiveDlpApiClient::DlpAdvancedRedactionResponse](docs/DlpAdvancedRedactionResponse.md)
121
+ - [CloudmersiveDlpApiClient::DlpAudioDetectionRequest](docs/DlpAudioDetectionRequest.md)
122
+ - [CloudmersiveDlpApiClient::DlpAudioDetectionResponse](docs/DlpAudioDetectionResponse.md)
123
+ - [CloudmersiveDlpApiClient::DlpAudioRedactionRequest](docs/DlpAudioRedactionRequest.md)
124
+ - [CloudmersiveDlpApiClient::DlpAudioRedactionResponse](docs/DlpAudioRedactionResponse.md)
125
+ - [CloudmersiveDlpApiClient::DlpBatchJobResult](docs/DlpBatchJobResult.md)
126
+ - [CloudmersiveDlpApiClient::DlpBatchJobStatusResult](docs/DlpBatchJobStatusResult.md)
106
127
  - [CloudmersiveDlpApiClient::DlpDetectionRequest](docs/DlpDetectionRequest.md)
107
128
  - [CloudmersiveDlpApiClient::DlpDetectionResponse](docs/DlpDetectionResponse.md)
108
129
  - [CloudmersiveDlpApiClient::DlpDocumentDetectionRequest](docs/DlpDocumentDetectionRequest.md)
@@ -110,6 +131,7 @@ Class | Method | HTTP request | Description
110
131
  - [CloudmersiveDlpApiClient::DlpDocumentRedactionResponse](docs/DlpDocumentRedactionResponse.md)
111
132
  - [CloudmersiveDlpApiClient::DlpRedactionRequest](docs/DlpRedactionRequest.md)
112
133
  - [CloudmersiveDlpApiClient::DlpRedactionResponse](docs/DlpRedactionResponse.md)
134
+ - [CloudmersiveDlpApiClient::RedactedAudioSegment](docs/RedactedAudioSegment.md)
113
135
  - [CloudmersiveDlpApiClient::RedactedPageInfo](docs/RedactedPageInfo.md)
114
136
 
115
137
 
@@ -0,0 +1,12 @@
1
+ # CloudmersiveDlpApiClient::AudioTimestamp
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **token** | **String** | The word or token recognized from the audio. | [optional]
7
+ **character_offset_start** | **Integer** | Start position of the token in the transcript text (character offset). | [optional]
8
+ **character_offset_end** | **Integer** | End position of the token in the transcript text (character offset). | [optional]
9
+ **start_time_ms** | **Integer** | Start time of the token in the audio, in milliseconds. | [optional]
10
+ **end_time_ms** | **Integer** | End time of the token in the audio, in milliseconds. | [optional]
11
+
12
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveDlpApiClient::CustomPiiField
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **title** | **String** | Short title for the custom field, also used to derive the semantic tag (uppercased, spaces/underscores replaced with hyphens). | [optional]
7
+ **description** | **String** | Description of what this field looks like, used to instruct the redaction LLM. Be specific so the LLM can locate matches. | [optional]
8
+
9
+
data/docs/DetectApi.md CHANGED
@@ -4,18 +4,130 @@ All URIs are relative to *https://localhost*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**detect_audio**](DetectApi.md#detect_audio) | **POST** /dlp/detect/audio | Detect User Data in Audio File
8
+ [**detect_audio_advanced**](DetectApi.md#detect_audio_advanced) | **POST** /dlp/detect/audio/advanced | Detect User Data in Audio File (Advanced)
7
9
  [**detect_document**](DetectApi.md#detect_document) | **POST** /dlp/detect/document | Detect User Data in Document Image
8
10
  [**detect_document_advanced**](DetectApi.md#detect_document_advanced) | **POST** /dlp/detect/document/advanced | Detect User Data in Document Image (Advanced)
9
11
  [**detect_text**](DetectApi.md#detect_text) | **POST** /dlp/detect/text | Detect User Data in Input Text
10
12
  [**detect_text_advanced**](DetectApi.md#detect_text_advanced) | **POST** /dlp/detect/text/advanced | Detect User Data in Input Text (Advanced)
11
13
 
12
14
 
15
+ # **detect_audio**
16
+ > DlpAudioDetectionResponse detect_audio(opts)
17
+
18
+ Detect User Data in Audio File
19
+
20
+ 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.
21
+
22
+ ### Example
23
+ ```ruby
24
+ # load the gem
25
+ require 'cloudmersive-dlp-api-client'
26
+ # setup authorization
27
+ CloudmersiveDlpApiClient.configure do |config|
28
+ # Configure API key authorization: Apikey
29
+ config.api_key['Apikey'] = 'YOUR API KEY'
30
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
31
+ #config.api_key_prefix['Apikey'] = 'Bearer'
32
+ end
33
+
34
+ api_instance = CloudmersiveDlpApiClient::DetectApi.new
35
+
36
+ opts = {
37
+ body: CloudmersiveDlpApiClient::DlpAudioDetectionRequest.new # DlpAudioDetectionRequest | Input request
38
+ }
39
+
40
+ begin
41
+ #Detect User Data in Audio File
42
+ result = api_instance.detect_audio(opts)
43
+ p result
44
+ rescue CloudmersiveDlpApiClient::ApiError => e
45
+ puts "Exception when calling DetectApi->detect_audio: #{e}"
46
+ end
47
+ ```
48
+
49
+ ### Parameters
50
+
51
+ Name | Type | Description | Notes
52
+ ------------- | ------------- | ------------- | -------------
53
+ **body** | [**DlpAudioDetectionRequest**](DlpAudioDetectionRequest.md)| Input request | [optional]
54
+
55
+ ### Return type
56
+
57
+ [**DlpAudioDetectionResponse**](DlpAudioDetectionResponse.md)
58
+
59
+ ### Authorization
60
+
61
+ [Apikey](../README.md#Apikey)
62
+
63
+ ### HTTP request headers
64
+
65
+ - **Content-Type**: application/json, text/json, application/*+json
66
+ - **Accept**: text/plain, application/json, text/json
67
+
68
+
69
+
70
+ # **detect_audio_advanced**
71
+ > DlpAdvancedAudioDetectionResponse detect_audio_advanced(opts)
72
+
73
+ Detect User Data in Audio File (Advanced)
74
+
75
+ 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.
76
+
77
+ ### Example
78
+ ```ruby
79
+ # load the gem
80
+ require 'cloudmersive-dlp-api-client'
81
+ # setup authorization
82
+ CloudmersiveDlpApiClient.configure do |config|
83
+ # Configure API key authorization: Apikey
84
+ config.api_key['Apikey'] = 'YOUR API KEY'
85
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
86
+ #config.api_key_prefix['Apikey'] = 'Bearer'
87
+ end
88
+
89
+ api_instance = CloudmersiveDlpApiClient::DetectApi.new
90
+
91
+ opts = {
92
+ body: CloudmersiveDlpApiClient::DlpAdvancedAudioDetectionRequest.new # DlpAdvancedAudioDetectionRequest | Input request
93
+ }
94
+
95
+ begin
96
+ #Detect User Data in Audio File (Advanced)
97
+ result = api_instance.detect_audio_advanced(opts)
98
+ p result
99
+ rescue CloudmersiveDlpApiClient::ApiError => e
100
+ puts "Exception when calling DetectApi->detect_audio_advanced: #{e}"
101
+ end
102
+ ```
103
+
104
+ ### Parameters
105
+
106
+ Name | Type | Description | Notes
107
+ ------------- | ------------- | ------------- | -------------
108
+ **body** | [**DlpAdvancedAudioDetectionRequest**](DlpAdvancedAudioDetectionRequest.md)| Input request | [optional]
109
+
110
+ ### Return type
111
+
112
+ [**DlpAdvancedAudioDetectionResponse**](DlpAdvancedAudioDetectionResponse.md)
113
+
114
+ ### Authorization
115
+
116
+ [Apikey](../README.md#Apikey)
117
+
118
+ ### HTTP request headers
119
+
120
+ - **Content-Type**: application/json, text/json, application/*+json
121
+ - **Accept**: text/plain, application/json, text/json
122
+
123
+
124
+
13
125
  # **detect_document**
14
126
  > DlpDetectionResponse detect_document(opts)
15
127
 
16
128
  Detect User Data in Document Image
17
129
 
18
- Detects configurable types of user data in a document image (PDF, DOCX, PNG, JPG) using Advanced AI.
130
+ 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.
19
131
 
20
132
  ### Example
21
133
  ```ruby
@@ -70,7 +182,7 @@ Name | Type | Description | Notes
70
182
 
71
183
  Detect User Data in Document Image (Advanced)
72
184
 
73
- Detects 29 configurable types of user data including health-related PHI in a document image (PDF, DOCX, PNG, JPG) using Advanced AI.
185
+ 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
186
 
75
187
  ### Example
76
188
  ```ruby
@@ -0,0 +1,48 @@
1
+ # CloudmersiveDlpApiClient::DlpAdvancedAudioDetectionRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **input_file** | **String** | Audio file bytes (WAV, MP3, M4A, FLAC, OGG, or WMA) to transcribe and scan for PII and sensitive data. | [optional]
7
+ **language_code** | **String** | Language code for speech recognition. Default is \"ENG\" (English). | [optional]
8
+ **allow_email_address** | **BOOLEAN** | Set to true to allow email addresses in the audio transcript and not flag them as PII. | [optional]
9
+ **allow_phone_number** | **BOOLEAN** | Set to true to allow phone numbers in the audio transcript and not flag them as PII. | [optional]
10
+ **allow_street_address** | **BOOLEAN** | Set to true to allow street addresses in the audio transcript and not flag them as PII. | [optional]
11
+ **allow_city** | **BOOLEAN** | Set to true to allow standalone city names (e.g. \"San Francisco\") in the audio transcript and not flag them as PII. Applies to city names mentioned outside of a full street address. | [optional]
12
+ **allow_person_name** | **BOOLEAN** | Set to true to allow person names in the audio transcript and not flag them as PII. | [optional]
13
+ **allow_birth_date** | **BOOLEAN** | Set to true to allow birth dates in the audio transcript and not flag them as PII. | [optional]
14
+ **allow_passport_number** | **BOOLEAN** | Set to true to allow passport numbers in the audio transcript and not flag them as PII. | [optional]
15
+ **allow_drivers_license** | **BOOLEAN** | Set to true to allow drivers license numbers in the audio transcript and not flag them as PII. | [optional]
16
+ **allow_social_security_number** | **BOOLEAN** | Set to true to allow social security numbers in the audio transcript and not flag them as PII. | [optional]
17
+ **allow_taxpayer_id** | **BOOLEAN** | Set to true to allow taxpayer IDs in the audio transcript and not flag them as PII. | [optional]
18
+ **allow_credit_card_number** | **BOOLEAN** | Set to true to allow credit card numbers in the audio transcript and not flag them as PII. | [optional]
19
+ **allow_credit_card_expiration_date** | **BOOLEAN** | Set to true to allow credit card expiration dates in the audio transcript and not flag them as PII. | [optional]
20
+ **allow_credit_card_verification_code** | **BOOLEAN** | Set to true to allow credit card verification codes in the audio transcript and not flag them as PII. | [optional]
21
+ **allow_bank_account_number** | **BOOLEAN** | Set to true to allow bank account numbers in the audio transcript and not flag them as PII. | [optional]
22
+ **allow_iban** | **BOOLEAN** | Set to true to allow IBANs in the audio transcript and not flag them as PII. | [optional]
23
+ **allow_health_insurance_number** | **BOOLEAN** | Set to true to allow health insurance numbers in the audio transcript and not flag them as PII. | [optional]
24
+ **allow_bearer_token** | **BOOLEAN** | Set to true to allow bearer tokens in the audio transcript and not flag them as PII. | [optional]
25
+ **allow_http_cookie** | **BOOLEAN** | Set to true to allow HTTP cookies in the audio transcript and not flag them as PII. | [optional]
26
+ **allow_private_keys** | **BOOLEAN** | Set to true to allow private keys in the audio transcript and not flag them as PII. | [optional]
27
+ **allow_credentials** | **BOOLEAN** | Set to true to allow credentials (usernames/passwords) in the audio transcript and not flag them as PII. | [optional]
28
+ **allow_deep_web_urls** | **BOOLEAN** | Set to true to allow deep web URLs (.onion) in the audio transcript and not flag them as PII. | [optional]
29
+ **allow_source_code** | **BOOLEAN** | Set to true to allow source code in the audio transcript and not flag it as sensitive data. | [optional]
30
+ **allow_ip_address** | **BOOLEAN** | Set to true to allow IP addresses in the audio transcript and not flag them as PII. | [optional]
31
+ **allow_mac_address** | **BOOLEAN** | Set to true to allow MAC addresses in the audio transcript and not flag them as PII. | [optional]
32
+ **allow_health_insurance_member_id** | **BOOLEAN** | Set to true to allow health insurance member IDs in the audio transcript and not flag them as PHI. | [optional]
33
+ **allow_medical_record_number** | **BOOLEAN** | Set to true to allow medical record numbers in the audio transcript and not flag them as PHI. | [optional]
34
+ **allow_billing_account_number** | **BOOLEAN** | Set to true to allow billing account numbers (e.g. provider/customer billing account IDs, distinct from bank account numbers) in the audio transcript and not flag them as PII. | [optional]
35
+ **allow_health_injury_or_disease** | **BOOLEAN** | Set to true to allow references to injuries or diseases in the audio transcript and not flag them as PHI. | [optional]
36
+ **allow_health_type_of_treatment** | **BOOLEAN** | Set to true to allow references to types of medical treatment in the audio transcript and not flag them as PHI. | [optional]
37
+ **allow_health_date_and_time_of_treatment** | **BOOLEAN** | Set to true to allow dates and times of medical treatment in the audio transcript and not flag them as PHI. | [optional]
38
+ **allow_health_plan_beneficiary_number** | **BOOLEAN** | Set to true to allow health plan beneficiary numbers in the audio transcript and not flag them as PHI. | [optional]
39
+ **allow_health_payments_made_for_treatment** | **BOOLEAN** | Set to true to allow payments made for medical treatment in the audio transcript and not flag them as PHI. | [optional]
40
+ **allow_vehicle_id** | **BOOLEAN** | Set to true to allow vehicle identifiers (e.g. license plates, VINs) in the audio transcript and not flag them as PII. | [optional]
41
+ **allow_device_id** | **BOOLEAN** | Set to true to allow device identifiers (e.g. serial numbers, IMEIs, MAC-level device IDs) in the audio transcript and not flag them as PII. | [optional]
42
+ **allow_names_of_relatives** | **BOOLEAN** | Set to true to allow names of relatives in the audio transcript and not flag them as PII. | [optional]
43
+ **allow_health_universal_record_locator** | **BOOLEAN** | Set to true to allow health universal record locators (URLs) in the audio transcript and not flag them as PHI. | [optional]
44
+ **allow_biometrics** | **BOOLEAN** | Set to true to allow biometric data references (e.g. fingerprints, retinal scans, voiceprints) in the audio transcript and not flag them as PII. | [optional]
45
+ **provide_analysis_rationale** | **BOOLEAN** | Set to true to include a natural language rationale explaining why each detection conclusion was formed. | [optional]
46
+ **custom_policy_id** | **String** | Apply a Custom Policy for DLP Enforcement by providing the ID; to create a Custom Policy, navigate to the Cloudmersive Management Portal and select Custom Policies. Requires Managed Instance or Private Cloud | [optional]
47
+
48
+
@@ -0,0 +1,48 @@
1
+ # CloudmersiveDlpApiClient::DlpAdvancedAudioDetectionResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **clean_result** | **BOOLEAN** | True if no disallowed PII or sensitive data types were detected; false if any disallowed type was found. | [optional]
7
+ **transcript** | **String** | Full transcript of the audio file. | [optional]
8
+ **timestamps** | [**Array<AudioTimestamp>**](AudioTimestamp.md) | Token-level timestamps from speech recognition. | [optional]
9
+ **contains_email_address** | **BOOLEAN** | True if the audio transcript contains email addresses. | [optional]
10
+ **contains_phone_number** | **BOOLEAN** | True if the audio transcript contains phone numbers. | [optional]
11
+ **contains_street_address** | **BOOLEAN** | True if the audio transcript contains street addresses. | [optional]
12
+ **contains_city** | **BOOLEAN** | True if the audio transcript contains standalone city names (e.g. \"San Francisco\") outside of a full street address. | [optional]
13
+ **contains_person_name** | **BOOLEAN** | True if the audio transcript contains person names. | [optional]
14
+ **contains_birth_date** | **BOOLEAN** | True if the audio transcript contains birth dates. | [optional]
15
+ **contains_passport_number** | **BOOLEAN** | True if the audio transcript contains passport numbers. | [optional]
16
+ **contains_drivers_license** | **BOOLEAN** | True if the audio transcript contains drivers license numbers. | [optional]
17
+ **contains_social_security_number** | **BOOLEAN** | True if the audio transcript contains social security numbers. | [optional]
18
+ **contains_taxpayer_id** | **BOOLEAN** | True if the audio transcript contains taxpayer IDs. | [optional]
19
+ **contains_credit_card_number** | **BOOLEAN** | True if the audio transcript contains credit card numbers. | [optional]
20
+ **contains_credit_card_expiration_date** | **BOOLEAN** | True if the audio transcript contains credit card expiration dates. | [optional]
21
+ **contains_credit_card_verification_code** | **BOOLEAN** | True if the audio transcript contains credit card verification codes. | [optional]
22
+ **contains_bank_account_number** | **BOOLEAN** | True if the audio transcript contains bank account numbers. | [optional]
23
+ **contains_iban** | **BOOLEAN** | True if the audio transcript contains IBANs. | [optional]
24
+ **contains_health_insurance_number** | **BOOLEAN** | True if the audio transcript contains health insurance numbers. | [optional]
25
+ **contains_bearer_token** | **BOOLEAN** | True if the audio transcript contains bearer tokens. | [optional]
26
+ **contains_http_cookie** | **BOOLEAN** | True if the audio transcript contains HTTP cookies. | [optional]
27
+ **contains_private_keys** | **BOOLEAN** | True if the audio transcript contains private keys. | [optional]
28
+ **contains_credentials** | **BOOLEAN** | True if the audio transcript contains credentials (usernames/passwords). | [optional]
29
+ **contains_deep_web_urls** | **BOOLEAN** | True if the audio transcript contains deep web URLs (.onion). | [optional]
30
+ **contains_source_code** | **BOOLEAN** | True if the audio transcript contains source code. | [optional]
31
+ **contains_ip_address** | **BOOLEAN** | True if the audio transcript contains IP addresses. | [optional]
32
+ **contains_mac_address** | **BOOLEAN** | True if the audio transcript contains MAC addresses. | [optional]
33
+ **contains_health_insurance_member_id** | **BOOLEAN** | True if the audio transcript contains health insurance member IDs. | [optional]
34
+ **contains_medical_record_number** | **BOOLEAN** | True if the audio transcript contains medical record numbers. | [optional]
35
+ **contains_billing_account_number** | **BOOLEAN** | True if the audio transcript contains billing account numbers (provider/customer billing account IDs, distinct from bank account numbers). | [optional]
36
+ **contains_health_injury_or_disease** | **BOOLEAN** | True if the audio transcript contains references to injuries or diseases. | [optional]
37
+ **contains_health_type_of_treatment** | **BOOLEAN** | True if the audio transcript contains references to types of medical treatment. | [optional]
38
+ **contains_health_date_and_time_of_treatment** | **BOOLEAN** | True if the audio transcript contains dates and times of medical treatment. | [optional]
39
+ **contains_health_plan_beneficiary_number** | **BOOLEAN** | True if the audio transcript contains health plan beneficiary numbers. | [optional]
40
+ **contains_health_payments_made_for_treatment** | **BOOLEAN** | True if the audio transcript contains payments made for medical treatment. | [optional]
41
+ **contains_vehicle_id** | **BOOLEAN** | True if the audio transcript contains vehicle identifiers (e.g. license plates, VINs). | [optional]
42
+ **contains_device_id** | **BOOLEAN** | True if the audio transcript contains device identifiers (e.g. serial numbers, IMEIs, MAC-level device IDs). | [optional]
43
+ **contains_names_of_relatives** | **BOOLEAN** | True if the audio transcript contains names of relatives. | [optional]
44
+ **contains_health_universal_record_locator** | **BOOLEAN** | True if the audio transcript contains health universal record locators (URLs). | [optional]
45
+ **contains_biometrics** | **BOOLEAN** | True if the audio transcript contains biometric data references (e.g. fingerprints, retinal scans, voiceprints). | [optional]
46
+ **analysis_rationale** | **String** | Rationale for why the conclusion was formed. Only populated when ProvideAnalysisRationale is set to true in the request. | [optional]
47
+
48
+
@@ -0,0 +1,54 @@
1
+ # CloudmersiveDlpApiClient::DlpAdvancedAudioRedactionRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **input_file** | **String** | Audio file bytes (WAV, MP3, M4A, FLAC, OGG, or WMA) to transcribe, scan for PII, and redact. | [optional]
7
+ **language_code** | **String** | Language code for speech recognition. Default is \"ENG\" (English). | [optional]
8
+ **allow_email_address** | **BOOLEAN** | Set to true to allow email addresses in the audio transcript and not redact them. | [optional]
9
+ **allow_phone_number** | **BOOLEAN** | Set to true to allow phone numbers in the audio transcript and not redact them. | [optional]
10
+ **allow_street_address** | **BOOLEAN** | Set to true to allow street addresses in the audio transcript and not redact them. | [optional]
11
+ **allow_city** | **BOOLEAN** | Set to true to allow standalone city names (e.g. \"San Francisco\") in the audio transcript and not redact them. Applies to city names mentioned outside of a full street address. | [optional]
12
+ **allow_person_name** | **BOOLEAN** | Set to true to allow person names in the audio transcript and not redact them. | [optional]
13
+ **allow_birth_date** | **BOOLEAN** | Set to true to allow birth dates in the audio transcript and not redact them. | [optional]
14
+ **allow_passport_number** | **BOOLEAN** | Set to true to allow passport numbers in the audio transcript and not redact them. | [optional]
15
+ **allow_drivers_license** | **BOOLEAN** | Set to true to allow drivers license numbers in the audio transcript and not redact them. | [optional]
16
+ **allow_social_security_number** | **BOOLEAN** | Set to true to allow social security numbers in the audio transcript and not redact them. | [optional]
17
+ **allow_taxpayer_id** | **BOOLEAN** | Set to true to allow taxpayer IDs in the audio transcript and not redact them. | [optional]
18
+ **allow_credit_card_number** | **BOOLEAN** | Set to true to allow credit card numbers in the audio transcript and not redact them. | [optional]
19
+ **allow_credit_card_expiration_date** | **BOOLEAN** | Set to true to allow credit card expiration dates in the audio transcript and not redact them. | [optional]
20
+ **allow_credit_card_verification_code** | **BOOLEAN** | Set to true to allow credit card verification codes in the audio transcript and not redact them. | [optional]
21
+ **allow_bank_account_number** | **BOOLEAN** | Set to true to allow bank account numbers in the audio transcript and not redact them. | [optional]
22
+ **allow_iban** | **BOOLEAN** | Set to true to allow IBANs in the audio transcript and not redact them. | [optional]
23
+ **allow_health_insurance_number** | **BOOLEAN** | Set to true to allow health insurance numbers in the audio transcript and not redact them. | [optional]
24
+ **allow_bearer_token** | **BOOLEAN** | Set to true to allow bearer tokens in the audio transcript and not redact them. | [optional]
25
+ **allow_http_cookie** | **BOOLEAN** | Set to true to allow HTTP cookies in the audio transcript and not redact them. | [optional]
26
+ **allow_private_keys** | **BOOLEAN** | Set to true to allow private keys in the audio transcript and not redact them. | [optional]
27
+ **allow_credentials** | **BOOLEAN** | Set to true to allow credentials (usernames/passwords) in the audio transcript and not redact them. | [optional]
28
+ **allow_deep_web_urls** | **BOOLEAN** | Set to true to allow deep web URLs (.onion) in the audio transcript and not redact them. | [optional]
29
+ **allow_source_code** | **BOOLEAN** | Set to true to allow source code in the audio transcript and not redact it. | [optional]
30
+ **allow_ip_address** | **BOOLEAN** | Set to true to allow IP addresses in the audio transcript and not redact them. | [optional]
31
+ **allow_mac_address** | **BOOLEAN** | Set to true to allow MAC addresses in the audio transcript and not redact them. | [optional]
32
+ **allow_health_insurance_member_id** | **BOOLEAN** | Set to true to allow health insurance member IDs in the audio transcript and not redact them. | [optional]
33
+ **allow_medical_record_number** | **BOOLEAN** | Set to true to allow medical record numbers in the audio transcript and not redact them. | [optional]
34
+ **allow_billing_account_number** | **BOOLEAN** | Set to true to allow billing account numbers (e.g. provider/customer billing account IDs, distinct from bank account numbers) in the audio transcript and not redact them. | [optional]
35
+ **allow_health_injury_or_disease** | **BOOLEAN** | Set to true to allow references to injuries or diseases in the audio transcript and not redact them. | [optional]
36
+ **allow_health_type_of_treatment** | **BOOLEAN** | Set to true to allow references to types of medical treatment in the audio transcript and not redact them. | [optional]
37
+ **allow_health_date_and_time_of_treatment** | **BOOLEAN** | Set to true to allow dates and times of medical treatment in the audio transcript and not redact them. | [optional]
38
+ **allow_health_plan_beneficiary_number** | **BOOLEAN** | Set to true to allow health plan beneficiary numbers in the audio transcript and not redact them. | [optional]
39
+ **allow_health_payments_made_for_treatment** | **BOOLEAN** | Set to true to allow payments made for medical treatment in the audio transcript and not redact them. | [optional]
40
+ **allow_vehicle_id** | **BOOLEAN** | Set to true to allow vehicle identifiers (e.g. license plates, VINs) in the audio transcript and not redact them. | [optional]
41
+ **allow_device_id** | **BOOLEAN** | Set to true to allow device identifiers (e.g. serial numbers, IMEIs, MAC-level device IDs) in the audio transcript and not redact them. | [optional]
42
+ **allow_names_of_relatives** | **BOOLEAN** | Set to true to allow names of relatives in the audio transcript and not redact them. | [optional]
43
+ **allow_health_universal_record_locator** | **BOOLEAN** | Set to true to allow health universal record locators (URLs) in the audio transcript and not redact them. | [optional]
44
+ **allow_biometrics** | **BOOLEAN** | Set to true to allow biometric data references (e.g. fingerprints, retinal scans, voiceprints) in the audio transcript and not redact them. | [optional]
45
+ **redaction_mode** | **String** | Redaction mode for audio: \"Bleep\" (default) replaces redacted audio segments with a bleep tone, or \"Mute\" zeroes out the audio for the redacted portions. | [optional]
46
+ **transcript_redaction_mode** | **String** | Redaction mode for the transcript text: \"SemanticTag\" (default) replaces PII with a semantic tag in square brackets (e.g. [PHONE-NUMBER]), \"Delete\" removes PII entirely, or \"ReplaceWithAsterisk\" replaces PII characters with asterisks (*). | [optional]
47
+ **provide_analysis_rationale** | **BOOLEAN** | Set to true to include a natural language rationale explaining why each detection conclusion was formed. | [optional]
48
+ **custom_policy_id** | **String** | Apply a Custom Policy for DLP Enforcement by providing the ID; to create a Custom Policy, navigate to the Cloudmersive Management Portal and select Custom Policies. Requires Managed Instance or Private Cloud | [optional]
49
+ **custom_fields** | [**Array<CustomPiiField>**](CustomPiiField.md) | Optional list of caller-defined custom PII fields to detect and redact in addition to the built-in categories. Each entry has a Title (used to derive the redaction tag, e.g. \"internal participant code\" → [INTERNAL-PARTICIPANT-CODE]) and a Description telling the redaction LLM what the field looks like. Default null. | [optional]
50
+ **expand_redaction_by_characters** | **Integer** | Optional override for the audio bleep/mute span padding. When set, expands each detected redaction range by this many CHARACTERS on each side before mapping to audio tokens (instead of the default token-radius expansion controlled by the DlpApi_Audio_ExpandRedactionByTokenRadius cloud configuration). Leave null to use the default token-radius behavior. | [optional]
51
+ **expand_redaction_by_ms** | **Integer** | Optional override for the audio bleep/mute span padding, expressed in MILLISECONDS. When set, the audio segment for each detected redaction starts this many ms earlier and ends this many ms later than the raw token-aligned span (clamped to >= 0 ms at the start). When set, this REPLACES both the token-radius expansion and the ExpandRedactionByCharacters override. Leave null to fall back to the character or token-based expansion modes. | [optional]
52
+ **speech_recognition_mode** | **String** | Optional. Speech recognition mode used when transcribing the audio for redaction. Available values: \"Fast\", \"Normal\", or \"Advanced\". Defaults to \"Normal\" when not specified. | [optional]
53
+
54
+
@@ -0,0 +1,51 @@
1
+ # CloudmersiveDlpApiClient::DlpAdvancedAudioRedactionResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **redacted_audio** | **String** | The redacted audio file bytes with PII segments bleeped or muted, or the original audio if no disallowed PII was found. | [optional]
7
+ **redacted_transcript** | **String** | The redacted transcript text with PII removed or replaced. | [optional]
8
+ **original_transcript** | **String** | Full original transcript of the audio file. | [optional]
9
+ **timestamps** | [**Array<AudioTimestamp>**](AudioTimestamp.md) | Token-level timestamps from speech recognition. | [optional]
10
+ **redacted_segments** | [**Array<RedactedAudioSegment>**](RedactedAudioSegment.md) | List of audio segments that were redacted, with their time ranges. | [optional]
11
+ **clean_result** | **BOOLEAN** | True if no disallowed PII or sensitive data types were detected; false if any disallowed type was found and redacted. | [optional]
12
+ **contains_email_address** | **BOOLEAN** | True if the audio transcript contains email addresses. | [optional]
13
+ **contains_phone_number** | **BOOLEAN** | True if the audio transcript contains phone numbers. | [optional]
14
+ **contains_street_address** | **BOOLEAN** | True if the audio transcript contains street addresses. | [optional]
15
+ **contains_city** | **BOOLEAN** | True if the audio transcript contains standalone city names (e.g. \"San Francisco\") outside of a full street address. | [optional]
16
+ **contains_person_name** | **BOOLEAN** | True if the audio transcript contains person names. | [optional]
17
+ **contains_birth_date** | **BOOLEAN** | True if the audio transcript contains birth dates. | [optional]
18
+ **contains_passport_number** | **BOOLEAN** | True if the audio transcript contains passport numbers. | [optional]
19
+ **contains_drivers_license** | **BOOLEAN** | True if the audio transcript contains drivers license numbers. | [optional]
20
+ **contains_social_security_number** | **BOOLEAN** | True if the audio transcript contains social security numbers. | [optional]
21
+ **contains_taxpayer_id** | **BOOLEAN** | True if the audio transcript contains taxpayer IDs. | [optional]
22
+ **contains_credit_card_number** | **BOOLEAN** | True if the audio transcript contains credit card numbers. | [optional]
23
+ **contains_credit_card_expiration_date** | **BOOLEAN** | True if the audio transcript contains credit card expiration dates. | [optional]
24
+ **contains_credit_card_verification_code** | **BOOLEAN** | True if the audio transcript contains credit card verification codes. | [optional]
25
+ **contains_bank_account_number** | **BOOLEAN** | True if the audio transcript contains bank account numbers. | [optional]
26
+ **contains_iban** | **BOOLEAN** | True if the audio transcript contains IBANs. | [optional]
27
+ **contains_health_insurance_number** | **BOOLEAN** | True if the audio transcript contains health insurance numbers. | [optional]
28
+ **contains_bearer_token** | **BOOLEAN** | True if the audio transcript contains bearer tokens. | [optional]
29
+ **contains_http_cookie** | **BOOLEAN** | True if the audio transcript contains HTTP cookies. | [optional]
30
+ **contains_private_keys** | **BOOLEAN** | True if the audio transcript contains private keys. | [optional]
31
+ **contains_credentials** | **BOOLEAN** | True if the audio transcript contains credentials (usernames/passwords). | [optional]
32
+ **contains_deep_web_urls** | **BOOLEAN** | True if the audio transcript contains deep web URLs (.onion). | [optional]
33
+ **contains_source_code** | **BOOLEAN** | True if the audio transcript contains source code. | [optional]
34
+ **contains_ip_address** | **BOOLEAN** | True if the audio transcript contains IP addresses. | [optional]
35
+ **contains_mac_address** | **BOOLEAN** | True if the audio transcript contains MAC addresses. | [optional]
36
+ **contains_health_insurance_member_id** | **BOOLEAN** | True if the audio transcript contains health insurance member IDs. | [optional]
37
+ **contains_medical_record_number** | **BOOLEAN** | True if the audio transcript contains medical record numbers. | [optional]
38
+ **contains_billing_account_number** | **BOOLEAN** | True if the audio transcript contains billing account numbers (provider/customer billing account IDs, distinct from bank account numbers). | [optional]
39
+ **contains_health_injury_or_disease** | **BOOLEAN** | True if the audio transcript contains references to injuries or diseases. | [optional]
40
+ **contains_health_type_of_treatment** | **BOOLEAN** | True if the audio transcript contains references to types of medical treatment. | [optional]
41
+ **contains_health_date_and_time_of_treatment** | **BOOLEAN** | True if the audio transcript contains dates and times of medical treatment. | [optional]
42
+ **contains_health_plan_beneficiary_number** | **BOOLEAN** | True if the audio transcript contains health plan beneficiary numbers. | [optional]
43
+ **contains_health_payments_made_for_treatment** | **BOOLEAN** | True if the audio transcript contains payments made for medical treatment. | [optional]
44
+ **contains_vehicle_id** | **BOOLEAN** | True if the audio transcript contains vehicle identifiers (e.g. license plates, VINs). | [optional]
45
+ **contains_device_id** | **BOOLEAN** | True if the audio transcript contains device identifiers (e.g. serial numbers, IMEIs, MAC-level device IDs). | [optional]
46
+ **contains_names_of_relatives** | **BOOLEAN** | True if the audio transcript contains names of relatives. | [optional]
47
+ **contains_health_universal_record_locator** | **BOOLEAN** | True if the audio transcript contains health universal record locators (URLs). | [optional]
48
+ **contains_biometrics** | **BOOLEAN** | True if the audio transcript contains biometric data references (e.g. fingerprints, retinal scans, voiceprints). | [optional]
49
+ **analysis_rationale** | **String** | Rationale for why the conclusion was formed. Only populated when ProvideAnalysisRationale is set to true in the request. | [optional]
50
+
51
+
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **allow_email_address** | **BOOLEAN** | Set to true to allow email addresses in the input text and not flag them as PII. | [optional]
8
8
  **allow_phone_number** | **BOOLEAN** | Set to true to allow phone numbers in the input text and not flag them as PII. | [optional]
9
9
  **allow_street_address** | **BOOLEAN** | Set to true to allow street addresses in the input text and not flag them as PII. | [optional]
10
+ **allow_city** | **BOOLEAN** | Set to true to allow standalone city names (e.g. \"San Francisco\") in the input text and not flag them as PII. Applies to city names mentioned outside of a full street address. | [optional]
10
11
  **allow_person_name** | **BOOLEAN** | Set to true to allow person names in the input text and not flag them as PII. | [optional]
11
12
  **allow_birth_date** | **BOOLEAN** | Set to true to allow birth dates in the input text and not flag them as PII. | [optional]
12
13
  **allow_passport_number** | **BOOLEAN** | Set to true to allow passport numbers in the input text and not flag them as PII. | [optional]
@@ -28,6 +29,8 @@ Name | Type | Description | Notes
28
29
  **allow_ip_address** | **BOOLEAN** | Set to true to allow IP addresses in the input text and not flag them as PII. | [optional]
29
30
  **allow_mac_address** | **BOOLEAN** | Set to true to allow MAC addresses in the input text and not flag them as PII. | [optional]
30
31
  **allow_health_insurance_member_id** | **BOOLEAN** | Set to true to allow health insurance member IDs in the input text and not flag them as PHI. | [optional]
32
+ **allow_medical_record_number** | **BOOLEAN** | Set to true to allow medical record numbers in the input text and not flag them as PHI. | [optional]
33
+ **allow_billing_account_number** | **BOOLEAN** | Set to true to allow billing account numbers (e.g. provider/customer billing account IDs, distinct from bank account numbers) in the input text and not flag them as PII. | [optional]
31
34
  **allow_health_injury_or_disease** | **BOOLEAN** | Set to true to allow references to injuries or diseases in the input text and not flag them as PHI. | [optional]
32
35
  **allow_health_type_of_treatment** | **BOOLEAN** | Set to true to allow references to types of medical treatment in the input text and not flag them as PHI. | [optional]
33
36
  **allow_health_date_and_time_of_treatment** | **BOOLEAN** | Set to true to allow dates and times of medical treatment in the input text and not flag them as PHI. | [optional]
@@ -39,5 +42,6 @@ Name | Type | Description | Notes
39
42
  **allow_health_universal_record_locator** | **BOOLEAN** | Set to true to allow health universal record locators (URLs) in the input text and not flag them as PHI. | [optional]
40
43
  **allow_biometrics** | **BOOLEAN** | Set to true to allow biometric data references (e.g. fingerprints, retinal scans, voiceprints) in the input text and not flag them as PII. | [optional]
41
44
  **provide_analysis_rationale** | **BOOLEAN** | Set to true to include a natural language rationale explaining why each detection conclusion was formed. | [optional]
45
+ **custom_policy_id** | **String** | Apply a Custom Policy for DLP Enforcement by providing the ID; to create a Custom Policy, navigate to the Cloudmersive Management Portal and select Custom Policies. Requires Managed Instance or Private Cloud | [optional]
42
46
 
43
47
 
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **contains_email_address** | **BOOLEAN** | True if the input text contains email addresses. | [optional]
8
8
  **contains_phone_number** | **BOOLEAN** | True if the input text contains phone numbers. | [optional]
9
9
  **contains_street_address** | **BOOLEAN** | True if the input text contains street addresses. | [optional]
10
+ **contains_city** | **BOOLEAN** | True if the input text contains standalone city names (e.g. \"San Francisco\") outside of a full street address. | [optional]
10
11
  **contains_person_name** | **BOOLEAN** | True if the input text contains person names. | [optional]
11
12
  **contains_birth_date** | **BOOLEAN** | True if the input text contains birth dates. | [optional]
12
13
  **contains_passport_number** | **BOOLEAN** | True if the input text contains passport numbers. | [optional]
@@ -28,6 +29,8 @@ Name | Type | Description | Notes
28
29
  **contains_ip_address** | **BOOLEAN** | True if the input text contains IP addresses. | [optional]
29
30
  **contains_mac_address** | **BOOLEAN** | True if the input text contains MAC addresses. | [optional]
30
31
  **contains_health_insurance_member_id** | **BOOLEAN** | True if the input text contains health insurance member IDs. | [optional]
32
+ **contains_medical_record_number** | **BOOLEAN** | True if the input text contains medical record numbers. | [optional]
33
+ **contains_billing_account_number** | **BOOLEAN** | True if the input text contains billing account numbers (provider/customer billing account IDs, distinct from bank account numbers). | [optional]
31
34
  **contains_health_injury_or_disease** | **BOOLEAN** | True if the input text contains references to injuries or diseases. | [optional]
32
35
  **contains_health_type_of_treatment** | **BOOLEAN** | True if the input text contains references to types of medical treatment. | [optional]
33
36
  **contains_health_date_and_time_of_treatment** | **BOOLEAN** | True if the input text contains dates and times of medical treatment. | [optional]
@@ -3,12 +3,13 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **input_file** | **String** | Document file bytes (PDF, DOCX, PNG, or JPG) to scan for PII and sensitive data. | [optional]
6
+ **input_file** | **String** | Document file bytes (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, or WEBP) to scan for PII and sensitive data. | [optional]
7
7
  **file_name** | **String** | Optional. Name of the input file including extension, used for format detection. If not provided, format is detected from file contents. | [optional]
8
- **recognition_mode** | **String** | Optional. Recognition mode for image processing. Options: null (default), \"Fast\", \"FastPlus\", \"FastMini\". | [optional]
8
+ **recognition_mode** | **String** | Optional. Recognition mode for image processing. Options: null (default), \"Normal\", \"Advanced\", \"Fast\", \"FastPlus\", \"FastMini\". | [optional]
9
9
  **allow_email_address** | **BOOLEAN** | Set to true to allow email addresses in the document and not flag them as PII. | [optional]
10
10
  **allow_phone_number** | **BOOLEAN** | Set to true to allow phone numbers in the document and not flag them as PII. | [optional]
11
11
  **allow_street_address** | **BOOLEAN** | Set to true to allow street addresses in the document and not flag them as PII. | [optional]
12
+ **allow_city** | **BOOLEAN** | Set to true to allow standalone city names (e.g. \"San Francisco\") in the document and not flag them as PII. Applies to city names mentioned outside of a full street address. | [optional]
12
13
  **allow_person_name** | **BOOLEAN** | Set to true to allow person names in the document and not flag them as PII. | [optional]
13
14
  **allow_birth_date** | **BOOLEAN** | Set to true to allow birth dates in the document and not flag them as PII. | [optional]
14
15
  **allow_passport_number** | **BOOLEAN** | Set to true to allow passport numbers in the document and not flag them as PII. | [optional]
@@ -30,6 +31,8 @@ Name | Type | Description | Notes
30
31
  **allow_ip_address** | **BOOLEAN** | Set to true to allow IP addresses in the document and not flag them as PII. | [optional]
31
32
  **allow_mac_address** | **BOOLEAN** | Set to true to allow MAC addresses in the document and not flag them as PII. | [optional]
32
33
  **allow_health_insurance_member_id** | **BOOLEAN** | Set to true to allow health insurance member IDs in the document and not flag them as PHI. | [optional]
34
+ **allow_medical_record_number** | **BOOLEAN** | Set to true to allow medical record numbers in the document and not flag them as PHI. | [optional]
35
+ **allow_billing_account_number** | **BOOLEAN** | Set to true to allow billing account numbers (e.g. provider/customer billing account IDs, distinct from bank account numbers) in the document and not flag them as PII. | [optional]
33
36
  **allow_health_injury_or_disease** | **BOOLEAN** | Set to true to allow references to injuries or diseases in the document and not flag them as PHI. | [optional]
34
37
  **allow_health_type_of_treatment** | **BOOLEAN** | Set to true to allow references to types of medical treatment in the document and not flag them as PHI. | [optional]
35
38
  **allow_health_date_and_time_of_treatment** | **BOOLEAN** | Set to true to allow dates and times of medical treatment in the document and not flag them as PHI. | [optional]
@@ -42,5 +45,6 @@ Name | Type | Description | Notes
42
45
  **allow_health_universal_record_locator** | **BOOLEAN** | Set to true to allow health universal record locators (URLs) in the document and not flag them as PHI. | [optional]
43
46
  **allow_biometrics** | **BOOLEAN** | Set to true to allow biometric data references (e.g. fingerprints, retinal scans, voiceprints) in the document and not flag them as PII. | [optional]
44
47
  **provide_analysis_rationale** | **BOOLEAN** | Set to true to include a natural language rationale explaining why each detection conclusion was formed. | [optional]
48
+ **custom_policy_id** | **String** | Apply a Custom Policy for DLP Enforcement by providing the ID; to create a Custom Policy, navigate to the Cloudmersive Management Portal and select Custom Policies. Requires Managed Instance or Private Cloud | [optional]
45
49
 
46
50
 
@@ -3,13 +3,14 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **input_file** | **String** | Document file bytes (PDF, DOCX, PNG, or JPG) to scan for PII and redact. | [optional]
6
+ **input_file** | **String** | Document file bytes (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, or WEBP) to scan for PII and redact. | [optional]
7
7
  **file_name** | **String** | Optional. Name of the input file including extension, used for format detection. If not provided, format is detected from file contents. | [optional]
8
- **recognition_mode** | **String** | Optional. Recognition mode for image processing. Options: null (default), \"Fast\", \"FastPlus\", \"FastMini\". | [optional]
8
+ **recognition_mode** | **String** | Optional. Recognition mode for image processing. Options: null (default), \"Normal\", \"Advanced\", \"Fast\", \"FastPlus\", \"FastMini\". | [optional]
9
9
  **redaction_mode** | **String** | Redaction mode for PII regions. Options: \"BlackOut\" (default) draws black rectangles over PII rows, \"Blur\" applies Gaussian blur to PII rows, \"BlackOutEntirePage\" blacks out entire dirty pages, \"BlurEntirePage\" blurs entire dirty pages. | [optional]
10
10
  **allow_email_address** | **BOOLEAN** | Set to true to allow email addresses in the document and not redact them. | [optional]
11
11
  **allow_phone_number** | **BOOLEAN** | Set to true to allow phone numbers in the document and not redact them. | [optional]
12
12
  **allow_street_address** | **BOOLEAN** | Set to true to allow street addresses in the document and not redact them. | [optional]
13
+ **allow_city** | **BOOLEAN** | Set to true to allow standalone city names (e.g. \"San Francisco\") in the document and not redact them. Applies to city names mentioned outside of a full street address. | [optional]
13
14
  **allow_person_name** | **BOOLEAN** | Set to true to allow person names in the document and not redact them. | [optional]
14
15
  **allow_birth_date** | **BOOLEAN** | Set to true to allow birth dates in the document and not redact them. | [optional]
15
16
  **allow_passport_number** | **BOOLEAN** | Set to true to allow passport numbers in the document and not redact them. | [optional]
@@ -31,6 +32,8 @@ Name | Type | Description | Notes
31
32
  **allow_ip_address** | **BOOLEAN** | Set to true to allow IP addresses in the document and not redact them. | [optional]
32
33
  **allow_mac_address** | **BOOLEAN** | Set to true to allow MAC addresses in the document and not redact them. | [optional]
33
34
  **allow_health_insurance_member_id** | **BOOLEAN** | Set to true to allow health insurance member IDs in the document and not redact them. | [optional]
35
+ **allow_medical_record_number** | **BOOLEAN** | Set to true to allow medical record numbers in the document and not redact them. | [optional]
36
+ **allow_billing_account_number** | **BOOLEAN** | Set to true to allow billing account numbers (e.g. provider/customer billing account IDs, distinct from bank account numbers) in the document and not redact them. | [optional]
34
37
  **allow_health_injury_or_disease** | **BOOLEAN** | Set to true to allow references to injuries or diseases in the document and not redact them. | [optional]
35
38
  **allow_health_type_of_treatment** | **BOOLEAN** | Set to true to allow references to types of medical treatment in the document and not redact them. | [optional]
36
39
  **allow_health_date_and_time_of_treatment** | **BOOLEAN** | Set to true to allow dates and times of medical treatment in the document and not redact them. | [optional]
@@ -43,5 +46,7 @@ Name | Type | Description | Notes
43
46
  **allow_health_universal_record_locator** | **BOOLEAN** | Set to true to allow health universal record locators (URLs) in the document and not redact them. | [optional]
44
47
  **allow_biometrics** | **BOOLEAN** | Set to true to allow biometric data references (e.g. fingerprints, retinal scans, voiceprints) in the document and not redact them. | [optional]
45
48
  **provide_analysis_rationale** | **BOOLEAN** | Set to true to include a natural language rationale explaining why each detection conclusion was formed. | [optional]
49
+ **custom_policy_id** | **String** | Apply a Custom Policy for DLP Enforcement by providing the ID; to create a Custom Policy, navigate to the Cloudmersive Management Portal and select Custom Policies. Requires Managed Instance or Private Cloud | [optional]
50
+ **custom_fields** | [**Array<CustomPiiField>**](CustomPiiField.md) | Optional list of caller-defined custom PII fields to detect and redact in addition to the built-in categories. Each entry has a Title (used to derive the redaction tag, e.g. \"internal participant code\" → [INTERNAL-PARTICIPANT-CODE]) and a Description telling the redaction LLM what the field looks like. Default null. | [optional]
46
51
 
47
52