moderation_api 1.2.0

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 (175) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +144 -0
  4. data/Rakefile +10 -0
  5. data/docs/AccountApi.md +74 -0
  6. data/docs/AccountGet200Response.md +26 -0
  7. data/docs/AccountGet200ResponseCurrentProject.md +20 -0
  8. data/docs/ActionsCreateRequest.md +36 -0
  9. data/docs/ActionsCreateRequestWebhooksInner.md +24 -0
  10. data/docs/ActionsDelete200Response.md +20 -0
  11. data/docs/ActionsExecute200Response.md +22 -0
  12. data/docs/ActionsExecuteDeprecatedRequest.md +22 -0
  13. data/docs/ActionsExecuteRequest.md +24 -0
  14. data/docs/ActionsGet200Response.md +40 -0
  15. data/docs/ActionsGet200ResponseWebhooksInner.md +26 -0
  16. data/docs/ActionsList200ResponseInner.md +38 -0
  17. data/docs/ActionsList200ResponseInnerPossibleValuesInner.md +18 -0
  18. data/docs/ActionsList400Response.md +22 -0
  19. data/docs/ActionsList400ResponseIssuesInner.md +18 -0
  20. data/docs/ActionsUpdateRequest.md +36 -0
  21. data/docs/ModerateApi.md +357 -0
  22. data/docs/ModerationAudioRequest.md +28 -0
  23. data/docs/ModerationImage200Response.md +28 -0
  24. data/docs/ModerationImage200ResponseLabelsInner.md +20 -0
  25. data/docs/ModerationImageRequest.md +28 -0
  26. data/docs/ModerationObject200Response.md +36 -0
  27. data/docs/ModerationObject200ResponseAllOfEntitiesInner.md +22 -0
  28. data/docs/ModerationObject200ResponseAllOfFieldsInner.md +22 -0
  29. data/docs/ModerationObject200ResponseAllOfLabelsInner.md +22 -0
  30. data/docs/ModerationObjectRequest.md +28 -0
  31. data/docs/ModerationObjectRequestValue.md +20 -0
  32. data/docs/ModerationObjectRequestValueDataValue.md +22 -0
  33. data/docs/ModerationText200Response.md +64 -0
  34. data/docs/ModerationText200ResponseAllOfAddress.md +28 -0
  35. data/docs/ModerationText200ResponseAllOfEmail.md +28 -0
  36. data/docs/ModerationText200ResponseAllOfName.md +28 -0
  37. data/docs/ModerationText200ResponseAllOfNsfw.md +26 -0
  38. data/docs/ModerationText200ResponseAllOfNsfwLabelScores.md +22 -0
  39. data/docs/ModerationText200ResponseAllOfPhone.md +28 -0
  40. data/docs/ModerationText200ResponseAllOfProfanity.md +28 -0
  41. data/docs/ModerationText200ResponseAllOfPropriety.md +26 -0
  42. data/docs/ModerationText200ResponseAllOfProprietyLabelScores.md +22 -0
  43. data/docs/ModerationText200ResponseAllOfQuality.md +26 -0
  44. data/docs/ModerationText200ResponseAllOfQualityLabelScores.md +24 -0
  45. data/docs/ModerationText200ResponseAllOfRequest.md +20 -0
  46. data/docs/ModerationText200ResponseAllOfSensitive.md +28 -0
  47. data/docs/ModerationText200ResponseAllOfSentiment.md +26 -0
  48. data/docs/ModerationText200ResponseAllOfSentimentLabelScores.md +22 -0
  49. data/docs/ModerationText200ResponseAllOfToxicity.md +26 -0
  50. data/docs/ModerationText200ResponseAllOfToxicityLabelScores.md +30 -0
  51. data/docs/ModerationText200ResponseAllOfUrl.md +28 -0
  52. data/docs/ModerationText200ResponseAllOfUsername.md +28 -0
  53. data/docs/ModerationText200ResponseAllOfWordlist.md +28 -0
  54. data/docs/ModerationText200ResponseAllOfWordlistsInner.md +36 -0
  55. data/docs/ModerationTextRequest.md +28 -0
  56. data/docs/ModerationVideo200Response.md +24 -0
  57. data/docs/ModerationVideoRequest.md +28 -0
  58. data/docs/QueueActionsApi.md +503 -0
  59. data/git_push.sh +57 -0
  60. data/lib/moderation_api/api/account_api.rb +79 -0
  61. data/lib/moderation_api/api/moderate_api.rb +362 -0
  62. data/lib/moderation_api/api/queue_actions_api.rb +492 -0
  63. data/lib/moderation_api/api_client.rb +437 -0
  64. data/lib/moderation_api/api_error.rb +58 -0
  65. data/lib/moderation_api/configuration.rb +392 -0
  66. data/lib/moderation_api/models/account_get200_response.rb +278 -0
  67. data/lib/moderation_api/models/account_get200_response_current_project.rb +237 -0
  68. data/lib/moderation_api/models/actions_create_request.rb +374 -0
  69. data/lib/moderation_api/models/actions_create_request_webhooks_inner.rb +260 -0
  70. data/lib/moderation_api/models/actions_delete200_response.rb +239 -0
  71. data/lib/moderation_api/models/actions_execute200_response.rb +258 -0
  72. data/lib/moderation_api/models/actions_execute_deprecated_request.rb +244 -0
  73. data/lib/moderation_api/models/actions_execute_request.rb +261 -0
  74. data/lib/moderation_api/models/actions_get200_response.rb +408 -0
  75. data/lib/moderation_api/models/actions_get200_response_webhooks_inner.rb +278 -0
  76. data/lib/moderation_api/models/actions_list200_response_inner.rb +396 -0
  77. data/lib/moderation_api/models/actions_list200_response_inner_possible_values_inner.rb +222 -0
  78. data/lib/moderation_api/models/actions_list400_response.rb +248 -0
  79. data/lib/moderation_api/models/actions_list400_response_issues_inner.rb +221 -0
  80. data/lib/moderation_api/models/actions_update_request.rb +367 -0
  81. data/lib/moderation_api/models/moderation_audio_request.rb +302 -0
  82. data/lib/moderation_api/models/moderation_image200_response.rb +296 -0
  83. data/lib/moderation_api/models/moderation_image200_response_labels_inner.rb +301 -0
  84. data/lib/moderation_api/models/moderation_image_request.rb +302 -0
  85. data/lib/moderation_api/models/moderation_object200_response.rb +368 -0
  86. data/lib/moderation_api/models/moderation_object200_response_all_of_entities_inner.rb +251 -0
  87. data/lib/moderation_api/models/moderation_object200_response_all_of_fields_inner.rb +258 -0
  88. data/lib/moderation_api/models/moderation_object200_response_all_of_labels_inner.rb +284 -0
  89. data/lib/moderation_api/models/moderation_object_request.rb +301 -0
  90. data/lib/moderation_api/models/moderation_object_request_value.rb +275 -0
  91. data/lib/moderation_api/models/moderation_object_request_value_data_value.rb +285 -0
  92. data/lib/moderation_api/models/moderation_text200_response.rb +488 -0
  93. data/lib/moderation_api/models/moderation_text200_response_all_of_address.rb +303 -0
  94. data/lib/moderation_api/models/moderation_text200_response_all_of_email.rb +303 -0
  95. data/lib/moderation_api/models/moderation_text200_response_all_of_name.rb +303 -0
  96. data/lib/moderation_api/models/moderation_text200_response_all_of_nsfw.rb +255 -0
  97. data/lib/moderation_api/models/moderation_text200_response_all_of_nsfw_label_scores.rb +235 -0
  98. data/lib/moderation_api/models/moderation_text200_response_all_of_phone.rb +303 -0
  99. data/lib/moderation_api/models/moderation_text200_response_all_of_profanity.rb +303 -0
  100. data/lib/moderation_api/models/moderation_text200_response_all_of_propriety.rb +255 -0
  101. data/lib/moderation_api/models/moderation_text200_response_all_of_propriety_label_scores.rb +235 -0
  102. data/lib/moderation_api/models/moderation_text200_response_all_of_quality.rb +255 -0
  103. data/lib/moderation_api/models/moderation_text200_response_all_of_quality_label_scores.rb +245 -0
  104. data/lib/moderation_api/models/moderation_text200_response_all_of_request.rb +240 -0
  105. data/lib/moderation_api/models/moderation_text200_response_all_of_sensitive.rb +303 -0
  106. data/lib/moderation_api/models/moderation_text200_response_all_of_sentiment.rb +255 -0
  107. data/lib/moderation_api/models/moderation_text200_response_all_of_sentiment_label_scores.rb +235 -0
  108. data/lib/moderation_api/models/moderation_text200_response_all_of_toxicity.rb +262 -0
  109. data/lib/moderation_api/models/moderation_text200_response_all_of_toxicity_label_scores.rb +275 -0
  110. data/lib/moderation_api/models/moderation_text200_response_all_of_url.rb +303 -0
  111. data/lib/moderation_api/models/moderation_text200_response_all_of_username.rb +303 -0
  112. data/lib/moderation_api/models/moderation_text200_response_all_of_wordlist.rb +303 -0
  113. data/lib/moderation_api/models/moderation_text200_response_all_of_wordlists_inner.rb +377 -0
  114. data/lib/moderation_api/models/moderation_text_request.rb +330 -0
  115. data/lib/moderation_api/models/moderation_video200_response.rb +265 -0
  116. data/lib/moderation_api/models/moderation_video_request.rb +302 -0
  117. data/lib/moderation_api/version.rb +15 -0
  118. data/lib/moderation_api.rb +93 -0
  119. data/moderation_api.gemspec +45 -0
  120. data/spec/api/account_api_spec.rb +46 -0
  121. data/spec/api/moderate_api_spec.rb +95 -0
  122. data/spec/api/queue_actions_api_spec.rb +121 -0
  123. data/spec/models/account_get200_response_current_project_spec.rb +42 -0
  124. data/spec/models/account_get200_response_spec.rb +60 -0
  125. data/spec/models/actions_create_request_spec.rb +98 -0
  126. data/spec/models/actions_create_request_webhooks_inner_spec.rb +54 -0
  127. data/spec/models/actions_delete200_response_spec.rb +42 -0
  128. data/spec/models/actions_execute200_response_spec.rb +48 -0
  129. data/spec/models/actions_execute_deprecated_request_spec.rb +48 -0
  130. data/spec/models/actions_execute_request_spec.rb +54 -0
  131. data/spec/models/actions_get200_response_spec.rb +110 -0
  132. data/spec/models/actions_get200_response_webhooks_inner_spec.rb +60 -0
  133. data/spec/models/actions_list200_response_inner_possible_values_inner_spec.rb +36 -0
  134. data/spec/models/actions_list200_response_inner_spec.rb +104 -0
  135. data/spec/models/actions_list400_response_issues_inner_spec.rb +36 -0
  136. data/spec/models/actions_list400_response_spec.rb +48 -0
  137. data/spec/models/actions_update_request_spec.rb +98 -0
  138. data/spec/models/moderation_audio_request_spec.rb +66 -0
  139. data/spec/models/moderation_image200_response_labels_inner_spec.rb +46 -0
  140. data/spec/models/moderation_image200_response_spec.rb +66 -0
  141. data/spec/models/moderation_image_request_spec.rb +66 -0
  142. data/spec/models/moderation_object200_response_all_of_entities_inner_spec.rb +48 -0
  143. data/spec/models/moderation_object200_response_all_of_fields_inner_spec.rb +48 -0
  144. data/spec/models/moderation_object200_response_all_of_labels_inner_spec.rb +48 -0
  145. data/spec/models/moderation_object200_response_spec.rb +90 -0
  146. data/spec/models/moderation_object_request_spec.rb +66 -0
  147. data/spec/models/moderation_object_request_value_data_value_spec.rb +52 -0
  148. data/spec/models/moderation_object_request_value_spec.rb +46 -0
  149. data/spec/models/moderation_text200_response_all_of_address_spec.rb +70 -0
  150. data/spec/models/moderation_text200_response_all_of_email_spec.rb +70 -0
  151. data/spec/models/moderation_text200_response_all_of_name_spec.rb +70 -0
  152. data/spec/models/moderation_text200_response_all_of_nsfw_label_scores_spec.rb +48 -0
  153. data/spec/models/moderation_text200_response_all_of_nsfw_spec.rb +60 -0
  154. data/spec/models/moderation_text200_response_all_of_phone_spec.rb +70 -0
  155. data/spec/models/moderation_text200_response_all_of_profanity_spec.rb +70 -0
  156. data/spec/models/moderation_text200_response_all_of_propriety_label_scores_spec.rb +48 -0
  157. data/spec/models/moderation_text200_response_all_of_propriety_spec.rb +60 -0
  158. data/spec/models/moderation_text200_response_all_of_quality_label_scores_spec.rb +54 -0
  159. data/spec/models/moderation_text200_response_all_of_quality_spec.rb +60 -0
  160. data/spec/models/moderation_text200_response_all_of_request_spec.rb +42 -0
  161. data/spec/models/moderation_text200_response_all_of_sensitive_spec.rb +70 -0
  162. data/spec/models/moderation_text200_response_all_of_sentiment_label_scores_spec.rb +48 -0
  163. data/spec/models/moderation_text200_response_all_of_sentiment_spec.rb +60 -0
  164. data/spec/models/moderation_text200_response_all_of_toxicity_label_scores_spec.rb +72 -0
  165. data/spec/models/moderation_text200_response_all_of_toxicity_spec.rb +60 -0
  166. data/spec/models/moderation_text200_response_all_of_url_spec.rb +70 -0
  167. data/spec/models/moderation_text200_response_all_of_username_spec.rb +70 -0
  168. data/spec/models/moderation_text200_response_all_of_wordlist_spec.rb +70 -0
  169. data/spec/models/moderation_text200_response_all_of_wordlists_inner_spec.rb +94 -0
  170. data/spec/models/moderation_text200_response_spec.rb +174 -0
  171. data/spec/models/moderation_text_request_spec.rb +66 -0
  172. data/spec/models/moderation_video200_response_spec.rb +54 -0
  173. data/spec/models/moderation_video_request_spec.rb +66 -0
  174. data/spec/spec_helper.rb +111 -0
  175. metadata +340 -0
@@ -0,0 +1,64 @@
1
+ # ModerationAPI::ModerationText200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | Success if the request was successful | |
8
+ | **request** | [**ModerationText200ResponseAllOfRequest**](ModerationText200ResponseAllOfRequest.md) | | |
9
+ | **flagged** | **Boolean** | Whether the content was flagged by any models | |
10
+ | **content_moderated** | **Boolean** | Whether the content was moderated or not. Same as `content` !== `original` | |
11
+ | **unicode_spoofing** | **Boolean** | Whether the content is using look-alike characters. Often used by spammers. | |
12
+ | **data_found** | **Boolean** | Whether any entity matchers found data for the content | |
13
+ | **original** | **String** | The original content | |
14
+ | **content** | **String** | The content after moderation. With all mask replacements applied and look-alike characters replaced with the original characters. | |
15
+ | **content_id** | **String** | The ID of the content. Only returned if the content was stored. | [optional] |
16
+ | **nsfw** | [**ModerationText200ResponseAllOfNsfw**](ModerationText200ResponseAllOfNsfw.md) | | [optional] |
17
+ | **toxicity** | [**ModerationText200ResponseAllOfToxicity**](ModerationText200ResponseAllOfToxicity.md) | | [optional] |
18
+ | **quality** | [**ModerationText200ResponseAllOfQuality**](ModerationText200ResponseAllOfQuality.md) | | [optional] |
19
+ | **sentiment** | [**ModerationText200ResponseAllOfSentiment**](ModerationText200ResponseAllOfSentiment.md) | | [optional] |
20
+ | **propriety** | [**ModerationText200ResponseAllOfPropriety**](ModerationText200ResponseAllOfPropriety.md) | | [optional] |
21
+ | **email** | [**ModerationText200ResponseAllOfEmail**](ModerationText200ResponseAllOfEmail.md) | | [optional] |
22
+ | **phone** | [**ModerationText200ResponseAllOfPhone**](ModerationText200ResponseAllOfPhone.md) | | [optional] |
23
+ | **url** | [**ModerationText200ResponseAllOfUrl**](ModerationText200ResponseAllOfUrl.md) | | [optional] |
24
+ | **address** | [**ModerationText200ResponseAllOfAddress**](ModerationText200ResponseAllOfAddress.md) | | [optional] |
25
+ | **name** | [**ModerationText200ResponseAllOfName**](ModerationText200ResponseAllOfName.md) | | [optional] |
26
+ | **username** | [**ModerationText200ResponseAllOfUsername**](ModerationText200ResponseAllOfUsername.md) | | [optional] |
27
+ | **profanity** | [**ModerationText200ResponseAllOfProfanity**](ModerationText200ResponseAllOfProfanity.md) | | [optional] |
28
+ | **sensitive** | [**ModerationText200ResponseAllOfSensitive**](ModerationText200ResponseAllOfSensitive.md) | | [optional] |
29
+ | **wordlist** | [**ModerationText200ResponseAllOfWordlist**](ModerationText200ResponseAllOfWordlist.md) | | [optional] |
30
+ | **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] |
31
+
32
+ ## Example
33
+
34
+ ```ruby
35
+ require 'moderation_api'
36
+
37
+ instance = ModerationAPI::ModerationText200Response.new(
38
+ status: null,
39
+ request: null,
40
+ flagged: null,
41
+ content_moderated: null,
42
+ unicode_spoofing: null,
43
+ data_found: null,
44
+ original: null,
45
+ content: null,
46
+ content_id: null,
47
+ nsfw: null,
48
+ toxicity: null,
49
+ quality: null,
50
+ sentiment: null,
51
+ propriety: null,
52
+ email: null,
53
+ phone: null,
54
+ url: null,
55
+ address: null,
56
+ name: null,
57
+ username: null,
58
+ profanity: null,
59
+ sensitive: null,
60
+ wordlist: null,
61
+ wordlists: null
62
+ )
63
+ ```
64
+
@@ -0,0 +1,28 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfAddress
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **mode** | **String** | The detection mode. | [optional] |
8
+ | **found** | **Boolean** | Whether a match was found or not. | [optional] |
9
+ | **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
10
+ | **components** | **Object** | The components of the matcher. | [optional] |
11
+ | **error** | **String** | Indicates an error with the matcher. | [optional] |
12
+ | **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] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'moderation_api'
18
+
19
+ instance = ModerationAPI::ModerationText200ResponseAllOfAddress.new(
20
+ mode: null,
21
+ found: null,
22
+ matches: null,
23
+ components: null,
24
+ error: null,
25
+ warning: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,28 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfEmail
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **mode** | **String** | The detection mode. | [optional] |
8
+ | **found** | **Boolean** | Whether a match was found or not. | [optional] |
9
+ | **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
10
+ | **components** | **Object** | The components of the matcher. | [optional] |
11
+ | **error** | **String** | Indicates an error with the matcher. | [optional] |
12
+ | **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] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'moderation_api'
18
+
19
+ instance = ModerationAPI::ModerationText200ResponseAllOfEmail.new(
20
+ mode: null,
21
+ found: null,
22
+ matches: null,
23
+ components: null,
24
+ error: null,
25
+ warning: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,28 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfName
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **mode** | **String** | The detection mode. | [optional] |
8
+ | **found** | **Boolean** | Whether a match was found or not. | [optional] |
9
+ | **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
10
+ | **components** | **Object** | The components of the matcher. | [optional] |
11
+ | **error** | **String** | Indicates an error with the matcher. | [optional] |
12
+ | **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] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'moderation_api'
18
+
19
+ instance = ModerationAPI::ModerationText200ResponseAllOfName.new(
20
+ mode: null,
21
+ found: null,
22
+ matches: null,
23
+ components: null,
24
+ error: null,
25
+ warning: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,26 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfNsfw
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **label** | **String** | The label of the model | [optional] |
8
+ | **score** | **Float** | The confidence of the model | [optional] |
9
+ | **error** | **String** | Indicates an error with the model | [optional] |
10
+ | **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] |
11
+ | **label_scores** | [**ModerationText200ResponseAllOfNsfwLabelScores**](ModerationText200ResponseAllOfNsfwLabelScores.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'moderation_api'
17
+
18
+ instance = ModerationAPI::ModerationText200ResponseAllOfNsfw.new(
19
+ label: null,
20
+ score: null,
21
+ error: null,
22
+ warning: null,
23
+ label_scores: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfNsfwLabelScores
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sensitive** | **Float** | Mentions religion, politics, race, etc., but is neutral or positive. | [optional] |
8
+ | **unsafe** | **Float** | Sexual, hateful, profane, and inappropriate content. | [optional] |
9
+ | **neutral** | **Float** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'moderation_api'
15
+
16
+ instance = ModerationAPI::ModerationText200ResponseAllOfNsfwLabelScores.new(
17
+ sensitive: null,
18
+ unsafe: null,
19
+ neutral: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,28 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfPhone
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **mode** | **String** | The detection mode. | [optional] |
8
+ | **found** | **Boolean** | Whether a match was found or not. | [optional] |
9
+ | **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
10
+ | **components** | **Object** | The components of the matcher. | [optional] |
11
+ | **error** | **String** | Indicates an error with the matcher. | [optional] |
12
+ | **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] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'moderation_api'
18
+
19
+ instance = ModerationAPI::ModerationText200ResponseAllOfPhone.new(
20
+ mode: null,
21
+ found: null,
22
+ matches: null,
23
+ components: null,
24
+ error: null,
25
+ warning: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,28 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfProfanity
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **mode** | **String** | The detection mode. | [optional] |
8
+ | **found** | **Boolean** | Whether a match was found or not. | [optional] |
9
+ | **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
10
+ | **components** | **Object** | The components of the matcher. | [optional] |
11
+ | **error** | **String** | Indicates an error with the matcher. | [optional] |
12
+ | **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] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'moderation_api'
18
+
19
+ instance = ModerationAPI::ModerationText200ResponseAllOfProfanity.new(
20
+ mode: null,
21
+ found: null,
22
+ matches: null,
23
+ components: null,
24
+ error: null,
25
+ warning: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,26 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfPropriety
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **label** | **String** | The label of the model | [optional] |
8
+ | **score** | **Float** | The confidence of the model | [optional] |
9
+ | **error** | **String** | Indicates an error with the model | [optional] |
10
+ | **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] |
11
+ | **label_scores** | [**ModerationText200ResponseAllOfProprietyLabelScores**](ModerationText200ResponseAllOfProprietyLabelScores.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'moderation_api'
17
+
18
+ instance = ModerationAPI::ModerationText200ResponseAllOfPropriety.new(
19
+ label: null,
20
+ score: null,
21
+ error: null,
22
+ warning: null,
23
+ label_scores: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfProprietyLabelScores
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **flirtation** | **Float** | Pickup lines, compliments on appearance, etc. | [optional] |
8
+ | **sexually_explicit** | **Float** | References to sexual acts, body parts, etc. | [optional] |
9
+ | **neutral** | **Float** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'moderation_api'
15
+
16
+ instance = ModerationAPI::ModerationText200ResponseAllOfProprietyLabelScores.new(
17
+ flirtation: null,
18
+ sexually_explicit: null,
19
+ neutral: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,26 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfQuality
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **label** | **String** | The label of the model | [optional] |
8
+ | **score** | **Float** | The confidence of the model | [optional] |
9
+ | **error** | **String** | Indicates an error with the model | [optional] |
10
+ | **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] |
11
+ | **label_scores** | [**ModerationText200ResponseAllOfQualityLabelScores**](ModerationText200ResponseAllOfQualityLabelScores.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'moderation_api'
17
+
18
+ instance = ModerationAPI::ModerationText200ResponseAllOfQuality.new(
19
+ label: null,
20
+ score: null,
21
+ error: null,
22
+ warning: null,
23
+ label_scores: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,24 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfQualityLabelScores
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **unsubstantial** | **Float** | Trivial or short content. | [optional] |
8
+ | **incoherent** | **Float** | Difficult to understand, nonsensical. | [optional] |
9
+ | **spam** | **Float** | Irrelevant and unsolicited commercial content. | [optional] |
10
+ | **neutral** | **Float** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'moderation_api'
16
+
17
+ instance = ModerationAPI::ModerationText200ResponseAllOfQualityLabelScores.new(
18
+ unsubstantial: null,
19
+ incoherent: null,
20
+ spam: null,
21
+ neutral: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **timestamp** | **Float** | The timestamp of the request | |
8
+ | **quota_usage** | **Float** | The quota usage of the request | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'moderation_api'
14
+
15
+ instance = ModerationAPI::ModerationText200ResponseAllOfRequest.new(
16
+ timestamp: null,
17
+ quota_usage: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,28 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfSensitive
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **mode** | **String** | The detection mode. | [optional] |
8
+ | **found** | **Boolean** | Whether a match was found or not. | [optional] |
9
+ | **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
10
+ | **components** | **Object** | The components of the matcher. | [optional] |
11
+ | **error** | **String** | Indicates an error with the matcher. | [optional] |
12
+ | **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] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'moderation_api'
18
+
19
+ instance = ModerationAPI::ModerationText200ResponseAllOfSensitive.new(
20
+ mode: null,
21
+ found: null,
22
+ matches: null,
23
+ components: null,
24
+ error: null,
25
+ warning: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,26 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfSentiment
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **label** | **String** | The label of the model | [optional] |
8
+ | **score** | **Float** | The confidence of the model | [optional] |
9
+ | **error** | **String** | Indicates an error with the model | [optional] |
10
+ | **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] |
11
+ | **label_scores** | [**ModerationText200ResponseAllOfSentimentLabelScores**](ModerationText200ResponseAllOfSentimentLabelScores.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'moderation_api'
17
+
18
+ instance = ModerationAPI::ModerationText200ResponseAllOfSentiment.new(
19
+ label: null,
20
+ score: null,
21
+ error: null,
22
+ warning: null,
23
+ label_scores: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfSentimentLabelScores
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **positive** | **Float** | Positive sentiment. | [optional] |
8
+ | **negative** | **Float** | Negative sentiment. | [optional] |
9
+ | **neutral** | **Float** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'moderation_api'
15
+
16
+ instance = ModerationAPI::ModerationText200ResponseAllOfSentimentLabelScores.new(
17
+ positive: null,
18
+ negative: null,
19
+ neutral: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,26 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfToxicity
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **label_scores** | [**ModerationText200ResponseAllOfToxicityLabelScores**](ModerationText200ResponseAllOfToxicityLabelScores.md) | | |
8
+ | **label** | **String** | The label of the model | [optional] |
9
+ | **score** | **Float** | The confidence of the model | [optional] |
10
+ | **error** | **String** | Indicates an error with the model | [optional] |
11
+ | **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] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'moderation_api'
17
+
18
+ instance = ModerationAPI::ModerationText200ResponseAllOfToxicity.new(
19
+ label_scores: null,
20
+ label: null,
21
+ score: null,
22
+ error: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,30 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfToxicityLabelScores
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **toxicity** | **Float** | Rude or disrespectful content. | [optional] |
8
+ | **profanity** | **Float** | Swearing, curse words, and other obscene language. | [optional] |
9
+ | **discrimination** | **Float** | Discrimination of race, religion, gender, etc. | [optional] |
10
+ | **severe_toxicity** | **Float** | Very hateful and aggressive content. | [optional] |
11
+ | **insult** | **Float** | Negative comments about looks or personality etc. | [optional] |
12
+ | **threat** | **Float** | Content containing intention to harm or violence. | [optional] |
13
+ | **neutral** | **Float** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'moderation_api'
19
+
20
+ instance = ModerationAPI::ModerationText200ResponseAllOfToxicityLabelScores.new(
21
+ toxicity: null,
22
+ profanity: null,
23
+ discrimination: null,
24
+ severe_toxicity: null,
25
+ insult: null,
26
+ threat: null,
27
+ neutral: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,28 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfUrl
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **mode** | **String** | The detection mode. | [optional] |
8
+ | **found** | **Boolean** | Whether a match was found or not. | [optional] |
9
+ | **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
10
+ | **components** | **Object** | The components of the matcher. | [optional] |
11
+ | **error** | **String** | Indicates an error with the matcher. | [optional] |
12
+ | **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] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'moderation_api'
18
+
19
+ instance = ModerationAPI::ModerationText200ResponseAllOfUrl.new(
20
+ mode: null,
21
+ found: null,
22
+ matches: null,
23
+ components: null,
24
+ error: null,
25
+ warning: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,28 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfUsername
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **mode** | **String** | The detection mode. | [optional] |
8
+ | **found** | **Boolean** | Whether a match was found or not. | [optional] |
9
+ | **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
10
+ | **components** | **Object** | The components of the matcher. | [optional] |
11
+ | **error** | **String** | Indicates an error with the matcher. | [optional] |
12
+ | **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] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'moderation_api'
18
+
19
+ instance = ModerationAPI::ModerationText200ResponseAllOfUsername.new(
20
+ mode: null,
21
+ found: null,
22
+ matches: null,
23
+ components: null,
24
+ error: null,
25
+ warning: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,28 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfWordlist
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **mode** | **String** | The detection mode. | [optional] |
8
+ | **found** | **Boolean** | Whether a match was found or not. | [optional] |
9
+ | **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
10
+ | **components** | **Object** | The components of the matcher. | [optional] |
11
+ | **error** | **String** | Indicates an error with the matcher. | [optional] |
12
+ | **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] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'moderation_api'
18
+
19
+ instance = ModerationAPI::ModerationText200ResponseAllOfWordlist.new(
20
+ mode: null,
21
+ found: null,
22
+ matches: null,
23
+ components: null,
24
+ error: null,
25
+ warning: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,36 @@
1
+ # ModerationAPI::ModerationText200ResponseAllOfWordlistsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **mode** | **String** | The flagging mode. | |
8
+ | **flagged** | **Boolean** | Whether the wordlists flagged the content. | |
9
+ | **name** | **String** | The name of the wordlist | |
10
+ | **id** | **String** | The ID of the wordlist | |
11
+ | **score** | **Float** | The score of the wordlist | |
12
+ | **found** | **Boolean** | Whether a match was found or not. | [optional] |
13
+ | **matches** | **Array<String>** | The matches of the entity matcher. | [optional] |
14
+ | **components** | **Object** | The components of the matcher. | [optional] |
15
+ | **error** | **String** | Indicates an error with the matcher. | [optional] |
16
+ | **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] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'moderation_api'
22
+
23
+ instance = ModerationAPI::ModerationText200ResponseAllOfWordlistsInner.new(
24
+ mode: null,
25
+ flagged: null,
26
+ name: null,
27
+ id: null,
28
+ score: null,
29
+ found: null,
30
+ matches: null,
31
+ components: null,
32
+ error: null,
33
+ warning: null
34
+ )
35
+ ```
36
+
@@ -0,0 +1,28 @@
1
+ # ModerationAPI::ModerationTextRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | The text you'd like to analyze. We recommend to submit plain text or HTML | |
8
+ | **content_id** | **String** | The unique ID of the content in your database. | [optional] |
9
+ | **do_not_store** | **Boolean** | Do not store the content. The content won't enter the review queue | [optional] |
10
+ | **author_id** | **String** | The author of the content. | [optional] |
11
+ | **context_id** | **String** | For example the ID of a chat room or a post | [optional] |
12
+ | **metadata** | **Hash<String, Object>** | Any metadata you want to store with the content | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'moderation_api'
18
+
19
+ instance = ModerationAPI::ModerationTextRequest.new(
20
+ value: null,
21
+ content_id: null,
22
+ do_not_store: null,
23
+ author_id: null,
24
+ context_id: null,
25
+ metadata: null
26
+ )
27
+ ```
28
+