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
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  **contains_email_address** | **BOOLEAN** | True if the document contains email addresses. | [optional]
9
9
  **contains_phone_number** | **BOOLEAN** | True if the document contains phone numbers. | [optional]
10
10
  **contains_street_address** | **BOOLEAN** | True if the document contains street addresses. | [optional]
11
+ **contains_city** | **BOOLEAN** | True if the document contains standalone city names (e.g. \"San Francisco\") outside of a full street address. | [optional]
11
12
  **contains_person_name** | **BOOLEAN** | True if the document contains person names. | [optional]
12
13
  **contains_birth_date** | **BOOLEAN** | True if the document contains birth dates. | [optional]
13
14
  **contains_passport_number** | **BOOLEAN** | True if the document contains passport numbers. | [optional]
@@ -29,6 +30,8 @@ Name | Type | Description | Notes
29
30
  **contains_ip_address** | **BOOLEAN** | True if the document contains IP addresses. | [optional]
30
31
  **contains_mac_address** | **BOOLEAN** | True if the document contains MAC addresses. | [optional]
31
32
  **contains_health_insurance_member_id** | **BOOLEAN** | True if the document contains health insurance member IDs. | [optional]
33
+ **contains_medical_record_number** | **BOOLEAN** | True if the document contains medical record numbers. | [optional]
34
+ **contains_billing_account_number** | **BOOLEAN** | True if the document contains billing account numbers (provider/customer billing account IDs, distinct from bank account numbers). | [optional]
32
35
  **contains_health_injury_or_disease** | **BOOLEAN** | True if the document contains references to injuries or diseases. | [optional]
33
36
  **contains_health_type_of_treatment** | **BOOLEAN** | True if the document contains references to types of medical treatment. | [optional]
34
37
  **contains_health_date_and_time_of_treatment** | **BOOLEAN** | True if the document contains dates and times of medical treatment. | [optional]
@@ -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 redact them. | [optional]
8
8
  **allow_phone_number** | **BOOLEAN** | Set to true to allow phone numbers in the input text and not redact them. | [optional]
9
9
  **allow_street_address** | **BOOLEAN** | Set to true to allow street addresses in the input text and not redact them. | [optional]
10
+ **allow_city** | **BOOLEAN** | Set to true to allow standalone city names (e.g. \"San Francisco\") in the input text and not redact them. 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 redact them. | [optional]
11
12
  **allow_birth_date** | **BOOLEAN** | Set to true to allow birth dates in the input text and not redact them. | [optional]
12
13
  **allow_passport_number** | **BOOLEAN** | Set to true to allow passport numbers in the input text and not redact them. | [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 redact them. | [optional]
29
30
  **allow_mac_address** | **BOOLEAN** | Set to true to allow MAC addresses in the input text and not redact them. | [optional]
30
31
  **allow_health_insurance_member_id** | **BOOLEAN** | Set to true to allow health insurance member IDs in the input text and not redact them. | [optional]
32
+ **allow_medical_record_number** | **BOOLEAN** | Set to true to allow medical record numbers in the input text and not redact them. | [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 redact them. | [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 redact them. | [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 redact them. | [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 redact them. | [optional]
@@ -38,7 +41,9 @@ Name | Type | Description | Notes
38
41
  **allow_names_of_relatives** | **BOOLEAN** | Set to true to allow names of relatives in the input text and not redact them. | [optional]
39
42
  **allow_health_universal_record_locator** | **BOOLEAN** | Set to true to allow health universal record locators (URLs) in the input text and not redact them. | [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 redact them. | [optional]
41
- **redaction_mode** | **String** | Redaction mode: \"Delete\" to remove PII entirely, or \"ReplaceWithAsterisk\" to replace PII characters with asterisks (*). | [optional]
44
+ **redaction_mode** | **String** | Redaction mode: \"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]
42
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
+ **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]
43
48
 
44
49
 
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  **contains_email_address** | **BOOLEAN** | True if the input contains email addresses. | [optional]
9
9
  **contains_phone_number** | **BOOLEAN** | True if the input contains phone numbers. | [optional]
10
10
  **contains_street_address** | **BOOLEAN** | True if the input contains street addresses. | [optional]
11
+ **contains_city** | **BOOLEAN** | True if the input contains standalone city names (e.g. \"San Francisco\") outside of a full street address. | [optional]
11
12
  **contains_person_name** | **BOOLEAN** | True if the input contains person names. | [optional]
12
13
  **contains_birth_date** | **BOOLEAN** | True if the input contains birth dates. | [optional]
13
14
  **contains_passport_number** | **BOOLEAN** | True if the input contains passport numbers. | [optional]
@@ -29,6 +30,8 @@ Name | Type | Description | Notes
29
30
  **contains_ip_address** | **BOOLEAN** | True if the input contains IP addresses. | [optional]
30
31
  **contains_mac_address** | **BOOLEAN** | True if the input contains MAC addresses. | [optional]
31
32
  **contains_health_insurance_member_id** | **BOOLEAN** | True if the input contains health insurance member IDs. | [optional]
33
+ **contains_medical_record_number** | **BOOLEAN** | True if the input contains medical record numbers. | [optional]
34
+ **contains_billing_account_number** | **BOOLEAN** | True if the input contains billing account numbers (provider/customer billing account IDs, distinct from bank account numbers). | [optional]
32
35
  **contains_health_injury_or_disease** | **BOOLEAN** | True if the input contains references to injuries or diseases. | [optional]
33
36
  **contains_health_type_of_treatment** | **BOOLEAN** | True if the input contains references to types of medical treatment. | [optional]
34
37
  **contains_health_date_and_time_of_treatment** | **BOOLEAN** | True if the input contains dates and times of medical treatment. | [optional]
@@ -0,0 +1,32 @@
1
+ # CloudmersiveDlpApiClient::DlpAudioDetectionRequest
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_person_name** | **BOOLEAN** | Set to true to allow person names in the audio transcript and not flag them as PII. | [optional]
12
+ **allow_birth_date** | **BOOLEAN** | Set to true to allow birth dates in the audio transcript and not flag them as PII. | [optional]
13
+ **allow_passport_number** | **BOOLEAN** | Set to true to allow passport numbers in the audio transcript and not flag them as PII. | [optional]
14
+ **allow_drivers_license** | **BOOLEAN** | Set to true to allow drivers license numbers in the audio transcript and not flag them as PII. | [optional]
15
+ **allow_social_security_number** | **BOOLEAN** | Set to true to allow social security numbers in the audio transcript and not flag them as PII. | [optional]
16
+ **allow_taxpayer_id** | **BOOLEAN** | Set to true to allow taxpayer IDs in the audio transcript and not flag them as PII. | [optional]
17
+ **allow_credit_card_number** | **BOOLEAN** | Set to true to allow credit card numbers in the audio transcript and not flag them as PII. | [optional]
18
+ **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]
19
+ **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]
20
+ **allow_bank_account_number** | **BOOLEAN** | Set to true to allow bank account numbers in the audio transcript and not flag them as PII. | [optional]
21
+ **allow_iban** | **BOOLEAN** | Set to true to allow IBANs in the audio transcript and not flag them as PII. | [optional]
22
+ **allow_health_insurance_number** | **BOOLEAN** | Set to true to allow health insurance numbers in the audio transcript and not flag them as PII. | [optional]
23
+ **allow_bearer_token** | **BOOLEAN** | Set to true to allow bearer tokens in the audio transcript and not flag them as PII. | [optional]
24
+ **allow_http_cookie** | **BOOLEAN** | Set to true to allow HTTP cookies in the audio transcript and not flag them as PII. | [optional]
25
+ **allow_private_keys** | **BOOLEAN** | Set to true to allow private keys in the audio transcript and not flag them as PII. | [optional]
26
+ **allow_credentials** | **BOOLEAN** | Set to true to allow credentials (usernames/passwords) in the audio transcript and not flag them as PII. | [optional]
27
+ **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]
28
+ **allow_source_code** | **BOOLEAN** | Set to true to allow source code in the audio transcript and not flag it as sensitive data. | [optional]
29
+ **allow_ip_address** | **BOOLEAN** | Set to true to allow IP addresses in the audio transcript and not flag them as PII. | [optional]
30
+ **allow_mac_address** | **BOOLEAN** | Set to true to allow MAC addresses in the audio transcript and not flag them as PII. | [optional]
31
+
32
+
@@ -0,0 +1,33 @@
1
+ # CloudmersiveDlpApiClient::DlpAudioDetectionResponse
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_person_name** | **BOOLEAN** | True if the audio transcript contains person names. | [optional]
13
+ **contains_birth_date** | **BOOLEAN** | True if the audio transcript contains birth dates. | [optional]
14
+ **contains_passport_number** | **BOOLEAN** | True if the audio transcript contains passport numbers. | [optional]
15
+ **contains_drivers_license** | **BOOLEAN** | True if the audio transcript contains drivers license numbers. | [optional]
16
+ **contains_social_security_number** | **BOOLEAN** | True if the audio transcript contains social security numbers. | [optional]
17
+ **contains_taxpayer_id** | **BOOLEAN** | True if the audio transcript contains taxpayer IDs. | [optional]
18
+ **contains_credit_card_number** | **BOOLEAN** | True if the audio transcript contains credit card numbers. | [optional]
19
+ **contains_credit_card_expiration_date** | **BOOLEAN** | True if the audio transcript contains credit card expiration dates. | [optional]
20
+ **contains_credit_card_verification_code** | **BOOLEAN** | True if the audio transcript contains credit card verification codes. | [optional]
21
+ **contains_bank_account_number** | **BOOLEAN** | True if the audio transcript contains bank account numbers. | [optional]
22
+ **contains_iban** | **BOOLEAN** | True if the audio transcript contains IBANs. | [optional]
23
+ **contains_health_insurance_number** | **BOOLEAN** | True if the audio transcript contains health insurance numbers. | [optional]
24
+ **contains_bearer_token** | **BOOLEAN** | True if the audio transcript contains bearer tokens. | [optional]
25
+ **contains_http_cookie** | **BOOLEAN** | True if the audio transcript contains HTTP cookies. | [optional]
26
+ **contains_private_keys** | **BOOLEAN** | True if the audio transcript contains private keys. | [optional]
27
+ **contains_credentials** | **BOOLEAN** | True if the audio transcript contains credentials (usernames/passwords). | [optional]
28
+ **contains_deep_web_urls** | **BOOLEAN** | True if the audio transcript contains deep web URLs (.onion). | [optional]
29
+ **contains_source_code** | **BOOLEAN** | True if the audio transcript contains source code. | [optional]
30
+ **contains_ip_address** | **BOOLEAN** | True if the audio transcript contains IP addresses. | [optional]
31
+ **contains_mac_address** | **BOOLEAN** | True if the audio transcript contains MAC addresses. | [optional]
32
+
33
+
@@ -0,0 +1,35 @@
1
+ # CloudmersiveDlpApiClient::DlpAudioRedactionRequest
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_person_name** | **BOOLEAN** | Set to true to allow person names in the audio transcript and not redact them. | [optional]
12
+ **allow_birth_date** | **BOOLEAN** | Set to true to allow birth dates in the audio transcript and not redact them. | [optional]
13
+ **allow_passport_number** | **BOOLEAN** | Set to true to allow passport numbers in the audio transcript and not redact them. | [optional]
14
+ **allow_drivers_license** | **BOOLEAN** | Set to true to allow drivers license numbers in the audio transcript and not redact them. | [optional]
15
+ **allow_social_security_number** | **BOOLEAN** | Set to true to allow social security numbers in the audio transcript and not redact them. | [optional]
16
+ **allow_taxpayer_id** | **BOOLEAN** | Set to true to allow taxpayer IDs in the audio transcript and not redact them. | [optional]
17
+ **allow_credit_card_number** | **BOOLEAN** | Set to true to allow credit card numbers in the audio transcript and not redact them. | [optional]
18
+ **allow_credit_card_expiration_date** | **BOOLEAN** | Set to true to allow credit card expiration dates in the audio transcript and not redact them. | [optional]
19
+ **allow_credit_card_verification_code** | **BOOLEAN** | Set to true to allow credit card verification codes in the audio transcript and not redact them. | [optional]
20
+ **allow_bank_account_number** | **BOOLEAN** | Set to true to allow bank account numbers in the audio transcript and not redact them. | [optional]
21
+ **allow_iban** | **BOOLEAN** | Set to true to allow IBANs in the audio transcript and not redact them. | [optional]
22
+ **allow_health_insurance_number** | **BOOLEAN** | Set to true to allow health insurance numbers in the audio transcript and not redact them. | [optional]
23
+ **allow_bearer_token** | **BOOLEAN** | Set to true to allow bearer tokens in the audio transcript and not redact them. | [optional]
24
+ **allow_http_cookie** | **BOOLEAN** | Set to true to allow HTTP cookies in the audio transcript and not redact them. | [optional]
25
+ **allow_private_keys** | **BOOLEAN** | Set to true to allow private keys in the audio transcript and not redact them. | [optional]
26
+ **allow_credentials** | **BOOLEAN** | Set to true to allow credentials (usernames/passwords) in the audio transcript and not redact them. | [optional]
27
+ **allow_deep_web_urls** | **BOOLEAN** | Set to true to allow deep web URLs (.onion) in the audio transcript and not redact them. | [optional]
28
+ **allow_source_code** | **BOOLEAN** | Set to true to allow source code in the audio transcript and not redact it. | [optional]
29
+ **allow_ip_address** | **BOOLEAN** | Set to true to allow IP addresses in the audio transcript and not redact them. | [optional]
30
+ **allow_mac_address** | **BOOLEAN** | Set to true to allow MAC addresses in the audio transcript and not redact them. | [optional]
31
+ **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]
32
+ **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]
33
+ **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]
34
+
35
+
@@ -0,0 +1,36 @@
1
+ # CloudmersiveDlpApiClient::DlpAudioRedactionResponse
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_person_name** | **BOOLEAN** | True if the audio transcript contains person names. | [optional]
16
+ **contains_birth_date** | **BOOLEAN** | True if the audio transcript contains birth dates. | [optional]
17
+ **contains_passport_number** | **BOOLEAN** | True if the audio transcript contains passport numbers. | [optional]
18
+ **contains_drivers_license** | **BOOLEAN** | True if the audio transcript contains drivers license numbers. | [optional]
19
+ **contains_social_security_number** | **BOOLEAN** | True if the audio transcript contains social security numbers. | [optional]
20
+ **contains_taxpayer_id** | **BOOLEAN** | True if the audio transcript contains taxpayer IDs. | [optional]
21
+ **contains_credit_card_number** | **BOOLEAN** | True if the audio transcript contains credit card numbers. | [optional]
22
+ **contains_credit_card_expiration_date** | **BOOLEAN** | True if the audio transcript contains credit card expiration dates. | [optional]
23
+ **contains_credit_card_verification_code** | **BOOLEAN** | True if the audio transcript contains credit card verification codes. | [optional]
24
+ **contains_bank_account_number** | **BOOLEAN** | True if the audio transcript contains bank account numbers. | [optional]
25
+ **contains_iban** | **BOOLEAN** | True if the audio transcript contains IBANs. | [optional]
26
+ **contains_health_insurance_number** | **BOOLEAN** | True if the audio transcript contains health insurance numbers. | [optional]
27
+ **contains_bearer_token** | **BOOLEAN** | True if the audio transcript contains bearer tokens. | [optional]
28
+ **contains_http_cookie** | **BOOLEAN** | True if the audio transcript contains HTTP cookies. | [optional]
29
+ **contains_private_keys** | **BOOLEAN** | True if the audio transcript contains private keys. | [optional]
30
+ **contains_credentials** | **BOOLEAN** | True if the audio transcript contains credentials (usernames/passwords). | [optional]
31
+ **contains_deep_web_urls** | **BOOLEAN** | True if the audio transcript contains deep web URLs (.onion). | [optional]
32
+ **contains_source_code** | **BOOLEAN** | True if the audio transcript contains source code. | [optional]
33
+ **contains_ip_address** | **BOOLEAN** | True if the audio transcript contains IP addresses. | [optional]
34
+ **contains_mac_address** | **BOOLEAN** | True if the audio transcript contains MAC addresses. | [optional]
35
+
36
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveDlpApiClient::DlpBatchJobResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
7
+ **async_job_id** | **String** | When creating a job, an Async Job ID is returned. Use the GetAsyncJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes | [optional]
8
+
9
+
@@ -0,0 +1,15 @@
1
+ # CloudmersiveDlpApiClient::DlpBatchJobStatusResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation to check the status of the job was successful, false otherwise | [optional]
7
+ **async_job_status** | **String** | Returns the job status of the Async Job, if applicable. Possible states are STARTED and COMPLETED | [optional]
8
+ **async_job_id** | **String** | Job ID | [optional]
9
+ **detect_audio_result** | [**DlpAudioDetectionResponse**](DlpAudioDetectionResponse.md) | | [optional]
10
+ **detect_audio_advanced_result** | [**DlpAdvancedAudioDetectionResponse**](DlpAdvancedAudioDetectionResponse.md) | | [optional]
11
+ **redact_audio_result** | [**DlpAudioRedactionResponse**](DlpAudioRedactionResponse.md) | | [optional]
12
+ **redact_audio_advanced_result** | [**DlpAdvancedAudioRedactionResponse**](DlpAdvancedAudioRedactionResponse.md) | | [optional]
13
+ **error_message** | **String** | Error message (if any) | [optional]
14
+
15
+
@@ -3,9 +3,9 @@
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]
@@ -3,9 +3,9 @@
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]
@@ -27,6 +27,6 @@ Name | Type | Description | Notes
27
27
  **allow_source_code** | **BOOLEAN** | Set to true to allow source code in the input text and not redact it. | [optional]
28
28
  **allow_ip_address** | **BOOLEAN** | Set to true to allow IP addresses in the input text and not redact them. | [optional]
29
29
  **allow_mac_address** | **BOOLEAN** | Set to true to allow MAC addresses in the input text and not redact them. | [optional]
30
- **redaction_mode** | **String** | Redaction mode: \"Delete\" to remove PII entirely, or \"ReplaceWithAsterisk\" to replace PII characters with asterisks (*). | [optional]
30
+ **redaction_mode** | **String** | Redaction mode: \"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]
31
31
 
32
32
 
data/docs/RedactApi.md CHANGED
@@ -4,18 +4,130 @@ All URIs are relative to *https://localhost*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**redact_audio**](RedactApi.md#redact_audio) | **POST** /dlp/redact/audio | Redact User Data in Audio File
8
+ [**redact_audio_advanced**](RedactApi.md#redact_audio_advanced) | **POST** /dlp/redact/audio/advanced | Redact User Data in Audio File (Advanced)
7
9
  [**redact_document**](RedactApi.md#redact_document) | **POST** /dlp/redact/document | Redact User Data in Document
8
10
  [**redact_document_advanced**](RedactApi.md#redact_document_advanced) | **POST** /dlp/redact/document/advanced | Redact User Data in Document (Advanced)
9
11
  [**redact_text**](RedactApi.md#redact_text) | **POST** /dlp/redact/text | Redact User Data in Input Text
10
12
  [**redact_text_advanced**](RedactApi.md#redact_text_advanced) | **POST** /dlp/redact/text/advanced | Redact User Data in Input Text (Advanced)
11
13
 
12
14
 
15
+ # **redact_audio**
16
+ > DlpAudioRedactionResponse redact_audio(opts)
17
+
18
+ Redact User Data in Audio File
19
+
20
+ 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.
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::RedactApi.new
35
+
36
+ opts = {
37
+ body: CloudmersiveDlpApiClient::DlpAudioRedactionRequest.new # DlpAudioRedactionRequest | Input request
38
+ }
39
+
40
+ begin
41
+ #Redact User Data in Audio File
42
+ result = api_instance.redact_audio(opts)
43
+ p result
44
+ rescue CloudmersiveDlpApiClient::ApiError => e
45
+ puts "Exception when calling RedactApi->redact_audio: #{e}"
46
+ end
47
+ ```
48
+
49
+ ### Parameters
50
+
51
+ Name | Type | Description | Notes
52
+ ------------- | ------------- | ------------- | -------------
53
+ **body** | [**DlpAudioRedactionRequest**](DlpAudioRedactionRequest.md)| Input request | [optional]
54
+
55
+ ### Return type
56
+
57
+ [**DlpAudioRedactionResponse**](DlpAudioRedactionResponse.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
+ # **redact_audio_advanced**
71
+ > DlpAdvancedAudioRedactionResponse redact_audio_advanced(opts)
72
+
73
+ Redact User Data in Audio File (Advanced)
74
+
75
+ 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.
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::RedactApi.new
90
+
91
+ opts = {
92
+ body: CloudmersiveDlpApiClient::DlpAdvancedAudioRedactionRequest.new # DlpAdvancedAudioRedactionRequest | Input request
93
+ }
94
+
95
+ begin
96
+ #Redact User Data in Audio File (Advanced)
97
+ result = api_instance.redact_audio_advanced(opts)
98
+ p result
99
+ rescue CloudmersiveDlpApiClient::ApiError => e
100
+ puts "Exception when calling RedactApi->redact_audio_advanced: #{e}"
101
+ end
102
+ ```
103
+
104
+ ### Parameters
105
+
106
+ Name | Type | Description | Notes
107
+ ------------- | ------------- | ------------- | -------------
108
+ **body** | [**DlpAdvancedAudioRedactionRequest**](DlpAdvancedAudioRedactionRequest.md)| Input request | [optional]
109
+
110
+ ### Return type
111
+
112
+ [**DlpAdvancedAudioRedactionResponse**](DlpAdvancedAudioRedactionResponse.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
  # **redact_document**
14
126
  > DlpDocumentRedactionResponse redact_document(opts)
15
127
 
16
128
  Redact User Data in Document
17
129
 
18
- 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.
130
+ 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.
19
131
 
20
132
  ### Example
21
133
  ```ruby
@@ -70,7 +182,7 @@ Name | Type | Description | Notes
70
182
 
71
183
  Redact User Data in Document (Advanced)
72
184
 
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.
185
+ 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
186
 
75
187
  ### Example
76
188
  ```ruby
@@ -0,0 +1,10 @@
1
+ # CloudmersiveDlpApiClient::RedactedAudioSegment
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **start_time_ms** | **Integer** | Start time of the redacted segment in the audio, in milliseconds. | [optional]
7
+ **end_time_ms** | **Integer** | End time of the redacted segment in the audio, in milliseconds. | [optional]
8
+ **redacted_text** | **String** | The original text that was redacted in this segment. | [optional]
9
+
10
+