cloudmersive-dlp-api-client

CloudmersiveDlpApiClient - the Ruby gem for the dlpapi

Easily and directly scan and detect sensitive data (PII) in input text.

This SDK is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: 2.2.1
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build cloudmersive-dlp-api-client.gemspec

Then either install the gem locally:

gem install ./cloudmersive-dlp-api-client-2.2.1.gem

(for development, run gem install --dev ./cloudmersive-dlp-api-client-2.2.1.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'cloudmersive-dlp-api-client', '~> 2.2.1'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'cloudmersive-dlp-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'cloudmersive-dlp-api-client'

# Setup authorization
CloudmersiveDlpApiClient.configure do |config|
  # Configure API key authorization: Apikey
  config.api_key['Apikey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Apikey'] = 'Bearer'
end

api_instance = CloudmersiveDlpApiClient::DetectApi.new

opts = { 
  body: CloudmersiveDlpApiClient::DlpAudioDetectionRequest.new # DlpAudioDetectionRequest | Input request
}

begin
  #Detect User Data in Audio File
  result = api_instance.detect_audio(opts)
  p result
rescue CloudmersiveDlpApiClient::ApiError => e
  puts "Exception when calling DetectApi->detect_audio: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://localhost

Class	Method	HTTP request	Description
CloudmersiveDlpApiClient::DetectApi	detect_audio	POST /dlp/detect/audio	Detect User Data in Audio File
CloudmersiveDlpApiClient::DetectApi	detect_audio_advanced	POST /dlp/detect/audio/advanced	Detect User Data in Audio File (Advanced)
CloudmersiveDlpApiClient::DetectApi	detect_document	POST /dlp/detect/document	Detect User Data in Document Image
CloudmersiveDlpApiClient::DetectApi	detect_document_advanced	POST /dlp/detect/document/advanced	Detect User Data in Document Image (Advanced)
CloudmersiveDlpApiClient::DetectApi	detect_text	POST /dlp/detect/text	Detect User Data in Input Text
CloudmersiveDlpApiClient::DetectApi	detect_text_advanced	POST /dlp/detect/text/advanced	Detect User Data in Input Text (Advanced)
CloudmersiveDlpApiClient::RedactApi	redact_audio	POST /dlp/redact/audio	Redact User Data in Audio File
CloudmersiveDlpApiClient::RedactApi	redact_audio_advanced	POST /dlp/redact/audio/advanced	Redact User Data in Audio File (Advanced)
CloudmersiveDlpApiClient::RedactApi	redact_document	POST /dlp/redact/document	Redact User Data in Document
CloudmersiveDlpApiClient::RedactApi	redact_document_advanced	POST /dlp/redact/document/advanced	Redact User Data in Document (Advanced)
CloudmersiveDlpApiClient::RedactApi	redact_text	POST /dlp/redact/text	Redact User Data in Input Text
CloudmersiveDlpApiClient::RedactApi	redact_text_advanced	POST /dlp/redact/text/advanced	Redact User Data in Input Text (Advanced)
CloudmersiveDlpApiClient::TasksBatchJobApi	detect_audio_advanced_batch_job	POST /dlp/batch-job/detect/audio/advanced	Detect User Data in Audio File (Advanced) as a Batch Job
CloudmersiveDlpApiClient::TasksBatchJobApi	detect_audio_batch_job	POST /dlp/batch-job/detect/audio	Detect User Data in Audio File as a Batch Job
CloudmersiveDlpApiClient::TasksBatchJobApi	get_async_job_status	GET /dlp/batch-job/status	Get the status and result of a DLP Batch Job
CloudmersiveDlpApiClient::TasksBatchJobApi	redact_audio_advanced_batch_job	POST /dlp/batch-job/redact/audio/advanced	Redact User Data in Audio File (Advanced) as a Batch Job
CloudmersiveDlpApiClient::TasksBatchJobApi	redact_audio_batch_job	POST /dlp/batch-job/redact/audio	Redact User Data in Audio File as a Batch Job

Documentation for Models

• CloudmersiveDlpApiClient::AudioTimestamp
• CloudmersiveDlpApiClient::CustomPiiField
• CloudmersiveDlpApiClient::DlpAdvancedAudioDetectionRequest
• CloudmersiveDlpApiClient::DlpAdvancedAudioDetectionResponse
• CloudmersiveDlpApiClient::DlpAdvancedAudioRedactionRequest
• CloudmersiveDlpApiClient::DlpAdvancedAudioRedactionResponse
• CloudmersiveDlpApiClient::DlpAdvancedDetectionRequest
• CloudmersiveDlpApiClient::DlpAdvancedDetectionResponse
• CloudmersiveDlpApiClient::DlpAdvancedDocumentDetectionRequest
• CloudmersiveDlpApiClient::DlpAdvancedDocumentRedactionRequest
• CloudmersiveDlpApiClient::DlpAdvancedDocumentRedactionResponse
• CloudmersiveDlpApiClient::DlpAdvancedRedactionRequest
• CloudmersiveDlpApiClient::DlpAdvancedRedactionResponse
• CloudmersiveDlpApiClient::DlpAudioDetectionRequest
• CloudmersiveDlpApiClient::DlpAudioDetectionResponse
• CloudmersiveDlpApiClient::DlpAudioRedactionRequest
• CloudmersiveDlpApiClient::DlpAudioRedactionResponse
• CloudmersiveDlpApiClient::DlpBatchJobResult
• CloudmersiveDlpApiClient::DlpBatchJobStatusResult
• CloudmersiveDlpApiClient::DlpDetectionRequest
• CloudmersiveDlpApiClient::DlpDetectionResponse
• CloudmersiveDlpApiClient::DlpDocumentDetectionRequest
• CloudmersiveDlpApiClient::DlpDocumentRedactionRequest
• CloudmersiveDlpApiClient::DlpDocumentRedactionResponse
• CloudmersiveDlpApiClient::DlpRedactionRequest
• CloudmersiveDlpApiClient::DlpRedactionResponse
• CloudmersiveDlpApiClient::RedactedAudioSegment
• CloudmersiveDlpApiClient::RedactedPageInfo

Documentation for Authorization

Apikey

• Type: API key
• API key parameter name: Apikey
• Location: HTTP header