moderation_api 1.2.1 → 2.0.0

data/docs/ModerateApi.md

@@ -1,357 +0,0 @@
-# ModerationAPI::ModerateApi
-
-All URIs are relative to *https://moderationapi.com/api/v1*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**moderation_audio**](ModerateApi.md#moderation_audio) | **POST** /moderate/audio | Analyze audio |
-| [**moderation_image**](ModerateApi.md#moderation_image) | **POST** /moderate/image | Analyze image |
-| [**moderation_object**](ModerateApi.md#moderation_object) | **POST** /moderate/object | Analyze object. |
-| [**moderation_text**](ModerateApi.md#moderation_text) | **POST** /moderate/text | Analyze text. |
-| [**moderation_video**](ModerateApi.md#moderation_video) | **POST** /moderate/video | Analyze video |
-
-
-## moderation_audio
-
-> <ModerationVideo200Response> moderation_audio(moderation_audio_request)
-
-Analyze audio
-
-Analyze audio with your Moderation API project
-
-### Examples
-
-```ruby
-require 'time'
-require 'moderation_api'
-# setup authorization
-ModerationAPI.configure do |config|
-  # Configure Bearer authorization: Authorization
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = ModerationAPI::ModerateApi.new
-moderation_audio_request = ModerationAPI::ModerationAudioRequest.new({url: 'url_example'}) # ModerationAudioRequest | 
-
-begin
-  # Analyze audio
-  result = api_instance.moderation_audio(moderation_audio_request)
-  p result
-rescue ModerationAPI::ApiError => e
-  puts "Error when calling ModerateApi->moderation_audio: #{e}"
-end
-```
-
-#### Using the moderation_audio_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ModerationVideo200Response>, Integer, Hash)> moderation_audio_with_http_info(moderation_audio_request)
-
-```ruby
-begin
-  # Analyze audio
-  data, status_code, headers = api_instance.moderation_audio_with_http_info(moderation_audio_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ModerationVideo200Response>
-rescue ModerationAPI::ApiError => e
-  puts "Error when calling ModerateApi->moderation_audio_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **moderation_audio_request** | [**ModerationAudioRequest**](ModerationAudioRequest.md) |  |  |
-
-### Return type
-
-[**ModerationVideo200Response**](ModerationVideo200Response.md)
-
-### Authorization
-
-[Authorization](../README.md#Authorization)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## moderation_image
-
-> <ModerationImage200Response> moderation_image(moderation_image_request)
-
-Analyze image
-
-Analyze image with your Moderation API project
-
-### Examples
-
-```ruby
-require 'time'
-require 'moderation_api'
-# setup authorization
-ModerationAPI.configure do |config|
-  # Configure Bearer authorization: Authorization
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = ModerationAPI::ModerateApi.new
-moderation_image_request = ModerationAPI::ModerationImageRequest.new({url: 'url_example'}) # ModerationImageRequest | 
-
-begin
-  # Analyze image
-  result = api_instance.moderation_image(moderation_image_request)
-  p result
-rescue ModerationAPI::ApiError => e
-  puts "Error when calling ModerateApi->moderation_image: #{e}"
-end
-```
-
-#### Using the moderation_image_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ModerationImage200Response>, Integer, Hash)> moderation_image_with_http_info(moderation_image_request)
-
-```ruby
-begin
-  # Analyze image
-  data, status_code, headers = api_instance.moderation_image_with_http_info(moderation_image_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ModerationImage200Response>
-rescue ModerationAPI::ApiError => e
-  puts "Error when calling ModerateApi->moderation_image_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **moderation_image_request** | [**ModerationImageRequest**](ModerationImageRequest.md) |  |  |
-
-### Return type
-
-[**ModerationImage200Response**](ModerationImage200Response.md)
-
-### Authorization
-
-[Authorization](../README.md#Authorization)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## moderation_object
-
-> <ModerationObject200Response> moderation_object(moderation_object_request)
-
-Analyze object.
-
-Analyze an object with multiple fields including text, images, video, audio. Use to moderate a post, a profile, a form submission or anything that have multiple fields.
-
-### Examples
-
-```ruby
-require 'time'
-require 'moderation_api'
-# setup authorization
-ModerationAPI.configure do |config|
-  # Configure Bearer authorization: Authorization
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = ModerationAPI::ModerateApi.new
-moderation_object_request = ModerationAPI::ModerationObjectRequest.new({value: ModerationAPI::ModerationObjectRequestValue.new({type: 'profile', data: { key: ModerationAPI::ModerationObjectRequestValueDataValue.new({type: 'text', value: 'value_example'})}})}) # ModerationObjectRequest | 
-
-begin
-  # Analyze object.
-  result = api_instance.moderation_object(moderation_object_request)
-  p result
-rescue ModerationAPI::ApiError => e
-  puts "Error when calling ModerateApi->moderation_object: #{e}"
-end
-```
-
-#### Using the moderation_object_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ModerationObject200Response>, Integer, Hash)> moderation_object_with_http_info(moderation_object_request)
-
-```ruby
-begin
-  # Analyze object.
-  data, status_code, headers = api_instance.moderation_object_with_http_info(moderation_object_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ModerationObject200Response>
-rescue ModerationAPI::ApiError => e
-  puts "Error when calling ModerateApi->moderation_object_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **moderation_object_request** | [**ModerationObjectRequest**](ModerationObjectRequest.md) |  |  |
-
-### Return type
-
-[**ModerationObject200Response**](ModerationObject200Response.md)
-
-### Authorization
-
-[Authorization](../README.md#Authorization)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## moderation_text
-
-> <ModerationText200Response> moderation_text(moderation_text_request)
-
-Analyze text.
-
-Analyze text with your Moderation API project.
-
-### Examples
-
-```ruby
-require 'time'
-require 'moderation_api'
-# setup authorization
-ModerationAPI.configure do |config|
-  # Configure Bearer authorization: Authorization
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = ModerationAPI::ModerateApi.new
-moderation_text_request = ModerationAPI::ModerationTextRequest.new({value: 'value_example'}) # ModerationTextRequest | 
-
-begin
-  # Analyze text.
-  result = api_instance.moderation_text(moderation_text_request)
-  p result
-rescue ModerationAPI::ApiError => e
-  puts "Error when calling ModerateApi->moderation_text: #{e}"
-end
-```
-
-#### Using the moderation_text_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ModerationText200Response>, Integer, Hash)> moderation_text_with_http_info(moderation_text_request)
-
-```ruby
-begin
-  # Analyze text.
-  data, status_code, headers = api_instance.moderation_text_with_http_info(moderation_text_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ModerationText200Response>
-rescue ModerationAPI::ApiError => e
-  puts "Error when calling ModerateApi->moderation_text_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **moderation_text_request** | [**ModerationTextRequest**](ModerationTextRequest.md) |  |  |
-
-### Return type
-
-[**ModerationText200Response**](ModerationText200Response.md)
-
-### Authorization
-
-[Authorization](../README.md#Authorization)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## moderation_video
-
-> <ModerationVideo200Response> moderation_video(moderation_video_request)
-
-Analyze video
-
-Analyze video with your Moderation API project
-
-### Examples
-
-```ruby
-require 'time'
-require 'moderation_api'
-# setup authorization
-ModerationAPI.configure do |config|
-  # Configure Bearer authorization: Authorization
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = ModerationAPI::ModerateApi.new
-moderation_video_request = ModerationAPI::ModerationVideoRequest.new({url: 'url_example'}) # ModerationVideoRequest | 
-
-begin
-  # Analyze video
-  result = api_instance.moderation_video(moderation_video_request)
-  p result
-rescue ModerationAPI::ApiError => e
-  puts "Error when calling ModerateApi->moderation_video: #{e}"
-end
-```
-
-#### Using the moderation_video_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ModerationVideo200Response>, Integer, Hash)> moderation_video_with_http_info(moderation_video_request)
-
-```ruby
-begin
-  # Analyze video
-  data, status_code, headers = api_instance.moderation_video_with_http_info(moderation_video_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ModerationVideo200Response>
-rescue ModerationAPI::ApiError => e
-  puts "Error when calling ModerateApi->moderation_video_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **moderation_video_request** | [**ModerationVideoRequest**](ModerationVideoRequest.md) |  |  |
-
-### Return type
-
-[**ModerationVideo200Response**](ModerationVideo200Response.md)
-
-### Authorization
-
-[Authorization](../README.md#Authorization)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

data/docs/ModerationAudioRequest.md

@@ -1,28 +0,0 @@
-# ModerationAPI::ModerationAudioRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **url** | **String** | The URL of the audio you want to analyze. |  |
-| **content_id** | **String** | The unique ID of the content in your database. | [optional] |
-| **do_not_store** | **Boolean** | Do not store the content. The content won't enter the review queue | [optional] |
-| **author_id** | **String** | The author of the content. | [optional] |
-| **context_id** | **String** | For example the ID of a chat room or a post | [optional] |
-| **metadata** | **Hash<String, Object>** | Any metadata you want to store with the content | [optional] |
-
-## Example
-
-```ruby
-require 'moderation_api'
-
-instance = ModerationAPI::ModerationAudioRequest.new(
-  url: null,
-  content_id: null,
-  do_not_store: null,
-  author_id: null,
-  context_id: null,
-  metadata: null
-)
-```
-

data/docs/ModerationImage200Response.md

@@ -1,28 +0,0 @@
-# ModerationAPI::ModerationImage200Response
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **status** | **String** | Success if the request was successful |  |
-| **request** | [**ModerationText200ResponseAllOfRequest**](ModerationText200ResponseAllOfRequest.md) |  |  |
-| **flagged** | **Boolean** | Whether the content was flagged by any models |  |
-| **labels** | [**Array<ModerationImage200ResponseLabelsInner>**](ModerationImage200ResponseLabelsInner.md) | The scores of each label |  |
-| **content_id** | **String** | The ID of the content. Only returned if the content was stored. | [optional] |
-| **texts** | **Array<String>** | The texts found in the image, if the image text model is enabled | [optional] |
-
-## Example
-
-```ruby
-require 'moderation_api'
-
-instance = ModerationAPI::ModerationImage200Response.new(
-  status: null,
-  request: null,
-  flagged: null,
-  labels: null,
-  content_id: null,
-  texts: null
-)
-```
-

data/docs/ModerationImage200ResponseLabelsInner.md

@@ -1,20 +0,0 @@
-# ModerationAPI::ModerationImage200ResponseLabelsInner
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **label** | **String** | The label of the model |  |
-| **score** | **Float** | The confidence of the model |  |
-
-## Example
-
-```ruby
-require 'moderation_api'
-
-instance = ModerationAPI::ModerationImage200ResponseLabelsInner.new(
-  label: null,
-  score: null
-)
-```
-

data/docs/ModerationImageRequest.md

@@ -1,28 +0,0 @@
-# ModerationAPI::ModerationImageRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **url** | **String** | The URL of the image you want to analyze. |  |
-| **content_id** | **String** | The unique ID of the content in your database. | [optional] |
-| **do_not_store** | **Boolean** | Do not store the content. The content won't enter the review queue | [optional] |
-| **author_id** | **String** | The author of the content. | [optional] |
-| **context_id** | **String** | For example the ID of a chat room or a post | [optional] |
-| **metadata** | **Hash<String, Object>** | Any metadata you want to store with the content | [optional] |
-
-## Example
-
-```ruby
-require 'moderation_api'
-
-instance = ModerationAPI::ModerationImageRequest.new(
-  url: null,
-  content_id: null,
-  do_not_store: null,
-  author_id: null,
-  context_id: null,
-  metadata: null
-)
-```
-

data/docs/ModerationObject200Response.md

@@ -1,36 +0,0 @@
-# ModerationAPI::ModerationObject200Response
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **status** | **String** | Success if the request was successful |  |
-| **request** | [**ModerationText200ResponseAllOfRequest**](ModerationText200ResponseAllOfRequest.md) |  |  |
-| **flagged** | **Boolean** | Whether the content was flagged by any models |  |
-| **unicode_spoofing** | **Boolean** | Whether the content is using look-alike characters. Often used by spammers. |  |
-| **data_found** | **Boolean** | Whether any entity matchers found data for the content |  |
-| **labels** | [**Array<ModerationObject200ResponseAllOfLabelsInner>**](ModerationObject200ResponseAllOfLabelsInner.md) | The scores of each label |  |
-| **entities** | [**Array<ModerationObject200ResponseAllOfEntitiesInner>**](ModerationObject200ResponseAllOfEntitiesInner.md) | The entities found in the content |  |
-| **fields** | [**Array<ModerationObject200ResponseAllOfFieldsInner>**](ModerationObject200ResponseAllOfFieldsInner.md) | The fields in the object and their flags |  |
-| **content_id** | **String** | The ID of the content. Only returned if the content was stored. | [optional] |
-| **wordlists** | [**Array<ModerationText200ResponseAllOfWordlistsInner>**](ModerationText200ResponseAllOfWordlistsInner.md) | The wordlist entity matcher outputs if enabled in your project. Read more at https://docs.moderationapi.com/models/word | [optional] |
-
-## Example
-
-```ruby
-require 'moderation_api'
-
-instance = ModerationAPI::ModerationObject200Response.new(
-  status: null,
-  request: null,
-  flagged: null,
-  unicode_spoofing: null,
-  data_found: null,
-  labels: null,
-  entities: null,
-  fields: null,
-  content_id: null,
-  wordlists: null
-)
-```
-

data/docs/ModerationObject200ResponseAllOfEntitiesInner.md

@@ -1,22 +0,0 @@
-# ModerationAPI::ModerationObject200ResponseAllOfEntitiesInner
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **model** | **String** | The model that found the entity |  |
-| **matches** | **Array<String>** | The matches of the entity |  |
-| **score** | **Float** | The similarity score of the matches | [optional] |
-
-## Example
-
-```ruby
-require 'moderation_api'
-
-instance = ModerationAPI::ModerationObject200ResponseAllOfEntitiesInner.new(
-  model: null,
-  matches: null,
-  score: null
-)
-```
-

data/docs/ModerationObject200ResponseAllOfFieldsInner.md

@@ -1,22 +0,0 @@
-# ModerationAPI::ModerationObject200ResponseAllOfFieldsInner
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **key** | **String** | The key of the field |  |
-| **flagged** | **Boolean** | Whether the field was flagged |  |
-| **flagged_by** | **Array<String>** | The models that flagged the field |  |
-
-## Example
-
-```ruby
-require 'moderation_api'
-
-instance = ModerationAPI::ModerationObject200ResponseAllOfFieldsInner.new(
-  key: null,
-  flagged: null,
-  flagged_by: null
-)
-```
-

data/docs/ModerationObject200ResponseAllOfLabelsInner.md

@@ -1,22 +0,0 @@
-# ModerationAPI::ModerationObject200ResponseAllOfLabelsInner
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **label** | **String** | The label of the model |  |
-| **model** | **String** | The model that found the label |  |
-| **score** | **Float** | The confidence of the model |  |
-
-## Example
-
-```ruby
-require 'moderation_api'
-
-instance = ModerationAPI::ModerationObject200ResponseAllOfLabelsInner.new(
-  label: null,
-  model: null,
-  score: null
-)
-```
-

data/docs/ModerationObjectRequest.md

@@ -1,28 +0,0 @@
-# ModerationAPI::ModerationObjectRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **value** | [**ModerationObjectRequestValue**](ModerationObjectRequestValue.md) |  |  |
-| **content_id** | **String** | The unique ID of the content in your database. | [optional] |
-| **do_not_store** | **Boolean** | Do not store the content. The content won't enter the review queue | [optional] |
-| **author_id** | **String** | The author of the content. | [optional] |
-| **context_id** | **String** | For example the ID of a chat room or a post | [optional] |
-| **metadata** | **Hash<String, Object>** | Any metadata you want to store with the content | [optional] |
-
-## Example
-
-```ruby
-require 'moderation_api'
-
-instance = ModerationAPI::ModerationObjectRequest.new(
-  value: null,
-  content_id: null,
-  do_not_store: null,
-  author_id: null,
-  context_id: null,
-  metadata: null
-)
-```
-

data/docs/ModerationObjectRequestValue.md

@@ -1,20 +0,0 @@
-# ModerationAPI::ModerationObjectRequestValue
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | **String** | The type of the object you want to analyze. |  |
-| **data** | [**Hash<String, ModerationObjectRequestValueDataValue>**](ModerationObjectRequestValueDataValue.md) |  |  |
-
-## Example
-
-```ruby
-require 'moderation_api'
-
-instance = ModerationAPI::ModerationObjectRequestValue.new(
-  type: null,
-  data: null
-)
-```
-

data/docs/ModerationObjectRequestValueDataValue.md

@@ -1,22 +0,0 @@
-# ModerationAPI::ModerationObjectRequestValueDataValue
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | **String** | The type of content (e.g., \"text\", \"image\", \"video\") |  |
-| **value** | **String** | The content to analyze |  |
-| **model_ids** | **Array<String>** | Optional array of specific model IDs to use | [optional] |
-
-## Example
-
-```ruby
-require 'moderation_api'
-
-instance = ModerationAPI::ModerationObjectRequestValueDataValue.new(
-  type: null,
-  value: null,
-  model_ids: null
-)
-```
-