moderation_api 1.2.0

data/docs/ModerationText200Response.md

@@ -0,0 +1,64 @@
+# ModerationAPI::ModerationText200Response
+
+## 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 |  |
+| **content_moderated** | **Boolean** | Whether the content was moderated or not. Same as `content` !== `original` |  |
+| **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 |  |
+| **original** | **String** | The original content |  |
+| **content** | **String** | The content after moderation. With all mask replacements applied and look-alike characters replaced with the original characters. |  |
+| **content_id** | **String** | The ID of the content. Only returned if the content was stored. | [optional] |
+| **nsfw** | [**ModerationText200ResponseAllOfNsfw**](ModerationText200ResponseAllOfNsfw.md) |  | [optional] |
+| **toxicity** | [**ModerationText200ResponseAllOfToxicity**](ModerationText200ResponseAllOfToxicity.md) |  | [optional] |
+| **quality** | [**ModerationText200ResponseAllOfQuality**](ModerationText200ResponseAllOfQuality.md) |  | [optional] |
+| **sentiment** | [**ModerationText200ResponseAllOfSentiment**](ModerationText200ResponseAllOfSentiment.md) |  | [optional] |
+| **propriety** | [**ModerationText200ResponseAllOfPropriety**](ModerationText200ResponseAllOfPropriety.md) |  | [optional] |
+| **email** | [**ModerationText200ResponseAllOfEmail**](ModerationText200ResponseAllOfEmail.md) |  | [optional] |
+| **phone** | [**ModerationText200ResponseAllOfPhone**](ModerationText200ResponseAllOfPhone.md) |  | [optional] |
+| **url** | [**ModerationText200ResponseAllOfUrl**](ModerationText200ResponseAllOfUrl.md) |  | [optional] |
+| **address** | [**ModerationText200ResponseAllOfAddress**](ModerationText200ResponseAllOfAddress.md) |  | [optional] |
+| **name** | [**ModerationText200ResponseAllOfName**](ModerationText200ResponseAllOfName.md) |  | [optional] |
+| **username** | [**ModerationText200ResponseAllOfUsername**](ModerationText200ResponseAllOfUsername.md) |  | [optional] |
+| **profanity** | [**ModerationText200ResponseAllOfProfanity**](ModerationText200ResponseAllOfProfanity.md) |  | [optional] |
+| **sensitive** | [**ModerationText200ResponseAllOfSensitive**](ModerationText200ResponseAllOfSensitive.md) |  | [optional] |
+| **wordlist** | [**ModerationText200ResponseAllOfWordlist**](ModerationText200ResponseAllOfWordlist.md) |  | [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::ModerationText200Response.new(
+  status: null,
+  request: null,
+  flagged: null,
+  content_moderated: null,
+  unicode_spoofing: null,
+  data_found: null,
+  original: null,
+  content: null,
+  content_id: null,
+  nsfw: null,
+  toxicity: null,
+  quality: null,
+  sentiment: null,
+  propriety: null,
+  email: null,
+  phone: null,
+  url: null,
+  address: null,
+  name: null,
+  username: null,
+  profanity: null,
+  sensitive: null,
+  wordlist: null,
+  wordlists: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfAddress.md

@@ -0,0 +1,28 @@
+# ModerationAPI::ModerationText200ResponseAllOfAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | The detection mode. | [optional] |
+| **found** | **Boolean** | Whether a match was found or not. | [optional] |
+| **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
+| **components** | **Object** | The components of the matcher. | [optional] |
+| **error** | **String** | Indicates an error with the matcher. | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfAddress.new(
+  mode: null,
+  found: null,
+  matches: null,
+  components: null,
+  error: null,
+  warning: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfEmail.md

@@ -0,0 +1,28 @@
+# ModerationAPI::ModerationText200ResponseAllOfEmail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | The detection mode. | [optional] |
+| **found** | **Boolean** | Whether a match was found or not. | [optional] |
+| **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
+| **components** | **Object** | The components of the matcher. | [optional] |
+| **error** | **String** | Indicates an error with the matcher. | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfEmail.new(
+  mode: null,
+  found: null,
+  matches: null,
+  components: null,
+  error: null,
+  warning: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfName.md

@@ -0,0 +1,28 @@
+# ModerationAPI::ModerationText200ResponseAllOfName
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | The detection mode. | [optional] |
+| **found** | **Boolean** | Whether a match was found or not. | [optional] |
+| **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
+| **components** | **Object** | The components of the matcher. | [optional] |
+| **error** | **String** | Indicates an error with the matcher. | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfName.new(
+  mode: null,
+  found: null,
+  matches: null,
+  components: null,
+  error: null,
+  warning: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfNsfw.md

@@ -0,0 +1,26 @@
+# ModerationAPI::ModerationText200ResponseAllOfNsfw
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | The label of the model | [optional] |
+| **score** | **Float** | The confidence of the model | [optional] |
+| **error** | **String** | Indicates an error with the model | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate | [optional] |
+| **label_scores** | [**ModerationText200ResponseAllOfNsfwLabelScores**](ModerationText200ResponseAllOfNsfwLabelScores.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfNsfw.new(
+  label: null,
+  score: null,
+  error: null,
+  warning: null,
+  label_scores: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfNsfwLabelScores.md

@@ -0,0 +1,22 @@
+# ModerationAPI::ModerationText200ResponseAllOfNsfwLabelScores
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sensitive** | **Float** | Mentions religion, politics, race, etc., but is neutral or positive. | [optional] |
+| **unsafe** | **Float** | Sexual, hateful, profane, and inappropriate content. | [optional] |
+| **neutral** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfNsfwLabelScores.new(
+  sensitive: null,
+  unsafe: null,
+  neutral: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfPhone.md

@@ -0,0 +1,28 @@
+# ModerationAPI::ModerationText200ResponseAllOfPhone
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | The detection mode. | [optional] |
+| **found** | **Boolean** | Whether a match was found or not. | [optional] |
+| **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
+| **components** | **Object** | The components of the matcher. | [optional] |
+| **error** | **String** | Indicates an error with the matcher. | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfPhone.new(
+  mode: null,
+  found: null,
+  matches: null,
+  components: null,
+  error: null,
+  warning: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfProfanity.md

@@ -0,0 +1,28 @@
+# ModerationAPI::ModerationText200ResponseAllOfProfanity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | The detection mode. | [optional] |
+| **found** | **Boolean** | Whether a match was found or not. | [optional] |
+| **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
+| **components** | **Object** | The components of the matcher. | [optional] |
+| **error** | **String** | Indicates an error with the matcher. | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfProfanity.new(
+  mode: null,
+  found: null,
+  matches: null,
+  components: null,
+  error: null,
+  warning: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfPropriety.md

@@ -0,0 +1,26 @@
+# ModerationAPI::ModerationText200ResponseAllOfPropriety
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | The label of the model | [optional] |
+| **score** | **Float** | The confidence of the model | [optional] |
+| **error** | **String** | Indicates an error with the model | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate | [optional] |
+| **label_scores** | [**ModerationText200ResponseAllOfProprietyLabelScores**](ModerationText200ResponseAllOfProprietyLabelScores.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfPropriety.new(
+  label: null,
+  score: null,
+  error: null,
+  warning: null,
+  label_scores: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfProprietyLabelScores.md

@@ -0,0 +1,22 @@
+# ModerationAPI::ModerationText200ResponseAllOfProprietyLabelScores
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flirtation** | **Float** | Pickup lines, compliments on appearance, etc. | [optional] |
+| **sexually_explicit** | **Float** | References to sexual acts, body parts, etc. | [optional] |
+| **neutral** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfProprietyLabelScores.new(
+  flirtation: null,
+  sexually_explicit: null,
+  neutral: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfQuality.md

@@ -0,0 +1,26 @@
+# ModerationAPI::ModerationText200ResponseAllOfQuality
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | The label of the model | [optional] |
+| **score** | **Float** | The confidence of the model | [optional] |
+| **error** | **String** | Indicates an error with the model | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate | [optional] |
+| **label_scores** | [**ModerationText200ResponseAllOfQualityLabelScores**](ModerationText200ResponseAllOfQualityLabelScores.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfQuality.new(
+  label: null,
+  score: null,
+  error: null,
+  warning: null,
+  label_scores: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfQualityLabelScores.md

@@ -0,0 +1,24 @@
+# ModerationAPI::ModerationText200ResponseAllOfQualityLabelScores
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **unsubstantial** | **Float** | Trivial or short content. | [optional] |
+| **incoherent** | **Float** | Difficult to understand, nonsensical. | [optional] |
+| **spam** | **Float** | Irrelevant and unsolicited commercial content. | [optional] |
+| **neutral** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfQualityLabelScores.new(
+  unsubstantial: null,
+  incoherent: null,
+  spam: null,
+  neutral: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfRequest.md

@@ -0,0 +1,20 @@
+# ModerationAPI::ModerationText200ResponseAllOfRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timestamp** | **Float** | The timestamp of the request |  |
+| **quota_usage** | **Float** | The quota usage of the request |  |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfRequest.new(
+  timestamp: null,
+  quota_usage: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfSensitive.md

@@ -0,0 +1,28 @@
+# ModerationAPI::ModerationText200ResponseAllOfSensitive
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | The detection mode. | [optional] |
+| **found** | **Boolean** | Whether a match was found or not. | [optional] |
+| **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
+| **components** | **Object** | The components of the matcher. | [optional] |
+| **error** | **String** | Indicates an error with the matcher. | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfSensitive.new(
+  mode: null,
+  found: null,
+  matches: null,
+  components: null,
+  error: null,
+  warning: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfSentiment.md

@@ -0,0 +1,26 @@
+# ModerationAPI::ModerationText200ResponseAllOfSentiment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | The label of the model | [optional] |
+| **score** | **Float** | The confidence of the model | [optional] |
+| **error** | **String** | Indicates an error with the model | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate | [optional] |
+| **label_scores** | [**ModerationText200ResponseAllOfSentimentLabelScores**](ModerationText200ResponseAllOfSentimentLabelScores.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfSentiment.new(
+  label: null,
+  score: null,
+  error: null,
+  warning: null,
+  label_scores: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfSentimentLabelScores.md

@@ -0,0 +1,22 @@
+# ModerationAPI::ModerationText200ResponseAllOfSentimentLabelScores
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **positive** | **Float** | Positive sentiment. | [optional] |
+| **negative** | **Float** | Negative sentiment. | [optional] |
+| **neutral** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfSentimentLabelScores.new(
+  positive: null,
+  negative: null,
+  neutral: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfToxicity.md

@@ -0,0 +1,26 @@
+# ModerationAPI::ModerationText200ResponseAllOfToxicity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label_scores** | [**ModerationText200ResponseAllOfToxicityLabelScores**](ModerationText200ResponseAllOfToxicityLabelScores.md) |  |  |
+| **label** | **String** | The label of the model | [optional] |
+| **score** | **Float** | The confidence of the model | [optional] |
+| **error** | **String** | Indicates an error with the model | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfToxicity.new(
+  label_scores: null,
+  label: null,
+  score: null,
+  error: null,
+  warning: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfToxicityLabelScores.md

@@ -0,0 +1,30 @@
+# ModerationAPI::ModerationText200ResponseAllOfToxicityLabelScores
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **toxicity** | **Float** | Rude or disrespectful content. | [optional] |
+| **profanity** | **Float** | Swearing, curse words, and other obscene language. | [optional] |
+| **discrimination** | **Float** | Discrimination of race, religion, gender, etc. | [optional] |
+| **severe_toxicity** | **Float** | Very hateful and aggressive content. | [optional] |
+| **insult** | **Float** | Negative comments about looks or personality etc. | [optional] |
+| **threat** | **Float** | Content containing intention to harm or violence. | [optional] |
+| **neutral** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfToxicityLabelScores.new(
+  toxicity: null,
+  profanity: null,
+  discrimination: null,
+  severe_toxicity: null,
+  insult: null,
+  threat: null,
+  neutral: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfUrl.md

@@ -0,0 +1,28 @@
+# ModerationAPI::ModerationText200ResponseAllOfUrl
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | The detection mode. | [optional] |
+| **found** | **Boolean** | Whether a match was found or not. | [optional] |
+| **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
+| **components** | **Object** | The components of the matcher. | [optional] |
+| **error** | **String** | Indicates an error with the matcher. | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfUrl.new(
+  mode: null,
+  found: null,
+  matches: null,
+  components: null,
+  error: null,
+  warning: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfUsername.md

@@ -0,0 +1,28 @@
+# ModerationAPI::ModerationText200ResponseAllOfUsername
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | The detection mode. | [optional] |
+| **found** | **Boolean** | Whether a match was found or not. | [optional] |
+| **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
+| **components** | **Object** | The components of the matcher. | [optional] |
+| **error** | **String** | Indicates an error with the matcher. | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfUsername.new(
+  mode: null,
+  found: null,
+  matches: null,
+  components: null,
+  error: null,
+  warning: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfWordlist.md

@@ -0,0 +1,28 @@
+# ModerationAPI::ModerationText200ResponseAllOfWordlist
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | The detection mode. | [optional] |
+| **found** | **Boolean** | Whether a match was found or not. | [optional] |
+| **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
+| **components** | **Object** | The components of the matcher. | [optional] |
+| **error** | **String** | Indicates an error with the matcher. | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfWordlist.new(
+  mode: null,
+  found: null,
+  matches: null,
+  components: null,
+  error: null,
+  warning: null
+)
+```
+

data/docs/ModerationText200ResponseAllOfWordlistsInner.md

@@ -0,0 +1,36 @@
+# ModerationAPI::ModerationText200ResponseAllOfWordlistsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | The flagging mode. |  |
+| **flagged** | **Boolean** | Whether the wordlists flagged the content. |  |
+| **name** | **String** | The name of the wordlist |  |
+| **id** | **String** | The ID of the wordlist |  |
+| **score** | **Float** | The score of the wordlist |  |
+| **found** | **Boolean** | Whether a match was found or not. | [optional] |
+| **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
+| **components** | **Object** | The components of the matcher. | [optional] |
+| **error** | **String** | Indicates an error with the matcher. | [optional] |
+| **warning** | **String** | Indicates a warning from the model, e.g. if the text is too short or long and the model might not be accurate. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ModerationText200ResponseAllOfWordlistsInner.new(
+  mode: null,
+  flagged: null,
+  name: null,
+  id: null,
+  score: null,
+  found: null,
+  matches: null,
+  components: null,
+  error: null,
+  warning: null
+)
+```
+

data/docs/ModerationTextRequest.md

@@ -0,0 +1,28 @@
+# ModerationAPI::ModerationTextRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** | The text you'd like to analyze. We recommend to submit plain text or HTML |  |
+| **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::ModerationTextRequest.new(
+  value: null,
+  content_id: null,
+  do_not_store: null,
+  author_id: null,
+  context_id: null,
+  metadata: null
+)
+```
+