Class: ModerationAPI::Resources::Content

Inherits:

Object

• Object
• ModerationAPI::Resources::Content

Defined in:

lib/moderation_api/resources/content.rb

Instance Method Summary

• #initialize(client:) ⇒ Content constructor private

  A new instance of Content.

• #submit(content:, author_id: nil, channel: nil, content_id: nil, conversation_id: nil, do_not_store: nil, metadata: nil, meta_type: nil, policies: nil, timestamp: nil, request_options: {}) ⇒ ModerationAPI::Models::ContentSubmitResponse

  Some parameter documentations has been truncated, see Models::ContentSubmitParams for more details.

Constructor Details

#initialize(client:) ⇒ Content

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Content.

Parameters:

• client (ModerationAPI::Client)

# File 'lib/moderation_api/resources/content.rb', line 50

def initialize(client:)
  @client = client
end

Instance Method Details

#submit(content:, author_id: nil, channel: nil, content_id: nil, conversation_id: nil, do_not_store: nil, metadata: nil, meta_type: nil, policies: nil, timestamp: nil, request_options: {}) ⇒ ModerationAPI::Models::ContentSubmitResponse

Some parameter documentations has been truncated, see Models::ContentSubmitParams for more details.

Parameters:

• content (ModerationAPI::Models::ContentSubmitParams::Content::Text, ModerationAPI::Models::ContentSubmitParams::Content::Image, ModerationAPI::Models::ContentSubmitParams::Content::Video, ModerationAPI::Models::ContentSubmitParams::Content::Audio, ModerationAPI::Models::ContentSubmitParams::Content::Object) —

  The content sent for moderation

• author_id (String) —

  The author of the content.

• channel (String) —

  Provide a channel ID or key. Will use the project’s default channel if not provi

• content_id (String) —

  The unique ID of the content in your database.

• conversation_id (String) —

  For example the ID of a chat room or a post

• do_not_store (Boolean) —

  Do not store the content. The content won’t enter the review queue

• metadata (Hash{Symbol=>Object}) —

  Any metadata you want to store with the content

• meta_type (Symbol, ModerationAPI::Models::ContentSubmitParams::MetaType) —

  The meta type of content being moderated

• policies (Array<ModerationAPI::Models::ContentSubmitParams::Policy::Toxicity, ModerationAPI::Models::ContentSubmitParams::Policy::PersonalInformation, ModerationAPI::Models::ContentSubmitParams::Policy::ToxicitySevere, ModerationAPI::Models::ContentSubmitParams::Policy::Hate, ModerationAPI::Models::ContentSubmitParams::Policy::Illicit, ModerationAPI::Models::ContentSubmitParams::Policy::IllicitDrugs, ModerationAPI::Models::ContentSubmitParams::Policy::IllicitAlcohol, ModerationAPI::Models::ContentSubmitParams::Policy::IllicitFirearms, ModerationAPI::Models::ContentSubmitParams::Policy::IllicitTobacco, ModerationAPI::Models::ContentSubmitParams::Policy::IllicitGambling, ModerationAPI::Models::ContentSubmitParams::Policy::Cannabis, ModerationAPI::Models::ContentSubmitParams::Policy::Adult, ModerationAPI::Models::ContentSubmitParams::Policy::Crypto, ModerationAPI::Models::ContentSubmitParams::Policy::Sexual, ModerationAPI::Models::ContentSubmitParams::Policy::Flirtation, ModerationAPI::Models::ContentSubmitParams::Policy::Profanity, ModerationAPI::Models::ContentSubmitParams::Policy::Violence, ModerationAPI::Models::ContentSubmitParams::Policy::SelfHarm, ModerationAPI::Models::ContentSubmitParams::Policy::Spam, ModerationAPI::Models::ContentSubmitParams::Policy::SelfPromotion, ModerationAPI::Models::ContentSubmitParams::Policy::Political, ModerationAPI::Models::ContentSubmitParams::Policy::Religion, ModerationAPI::Models::ContentSubmitParams::Policy::CodeAbuse, ModerationAPI::Models::ContentSubmitParams::Policy::PiiMasking, ModerationAPI::Models::ContentSubmitParams::Policy::URLMasking, ModerationAPI::Models::ContentSubmitParams::Policy::URLRisk, ModerationAPI::Models::ContentSubmitParams::Policy::Guideline>) —

  (Enterprise) override the channel policies for this moderation request only.

• timestamp (Float) —

  Unix timestamp (in milliseconds) of when the content was created. Use if content

• request_options (ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (ModerationAPI::Models::ContentSubmitResponse)

See Also:

• Models::ContentSubmitParams

# File 'lib/moderation_api/resources/content.rb', line 36

def submit(params)
  parsed, options = ModerationAPI::ContentSubmitParams.dump_request(params)
  @client.request(
    method: :post,
    path: "moderate",
    body: parsed,
    model: ModerationAPI::Models::ContentSubmitResponse,
    options: options
  )
end