Class: SafetyKit::Models::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/safety_kit/models/async_create_async_params.rb

Defined Under Namespace

Modules: Content, Metadata, ResourcesUsed, SourceType, Type Classes: ClientInfo

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(ip: nil) ⇒ Object

Client context observed by your backend for the user action that triggered the event.

Parameters:

  • ip (String) (defaults to: nil) —

    IP address observed by your backend for the client that triggered the event.




# File 'lib/safety_kit/models/async_create_async_params.rb', line 2630

Instance Attribute Details

#client_info ⇒ SafetyKit::Models::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest::ClientInfo?

Client context observed by your backend for the user action that triggered the event.

Returns:



2575
2576
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 2575

optional :client_info,
-> { SafetyKit::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest::ClientInfo }

#content ⇒ Array<SafetyKit::Models::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest::Content::EventTextContent, SafetyKit::Models::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest::Content::EventImageContent>?

User-authored or user-uploaded content parts. Use this for message bodies, bios, listing text, image URLs, and similar content SafetyKit should compare or analyze.

Returns:



2584
2585
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 2584

optional :content,
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest::Content] }

#content_id ⇒ String?

Your stable identifier for the content involved in this event, such as a message, listing, page, post, profile, or uploaded media item.

Returns:

  • (String, nil) 


2592
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 2592

optional :content_id, String

#event_name ⇒ String

Stable, low-cardinality product action name. Use snake_case and put dynamic values in typed fields, content, resources_used, or metadata.

Returns:

  • (String) 


2532
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 2532

required :event_name, String

#idempotency_key ⇒ String?

Optional caller-provided key used to make retries of this individual event idempotent. Reuse the same key only for retries of the same logical event.

Returns:

  • (String, nil) 


2599
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 2599

optional :idempotency_key, String

#labels ⇒ Array<String>

One or more label categories supplied with the report or moderation decision.

Returns:

  • (Array<String>) 


2538
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 2538

required :labels, SafetyKit::Internal::Type::ArrayOf[String]

#metadata ⇒ Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}?

Non-PII product context for filtering, segmentation, and debugging. Values may be strings, numbers, booleans, or arrays of those scalar values.

Returns:

  • (Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil) 


2606
2607
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 2606

optional :metadata,
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest::Metadata] }

#resources_used ⇒ Array<SafetyKit::Models::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest::ResourcesUsed::UnionMember1>?

Reusable resources observed during the event. Use this for emails, phone numbers, names, addresses, social handles, URLs, payment identifiers, caller-defined ids, or similar identifiers.

Returns:



2615
2616
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 2615

optional :resources_used,
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest::ResourcesUsed] }

#source_id ⇒ String

Stable identifier within source_type. Examples: moderator@example.com or 550e8400-e29b-41d4-a716-446655440000 for expert_labeler or human_moderator, automated_review_v2026_06_04 for automation, or <vendor_name>-v2.1 for vendor.

Returns:

  • (String) 


2546
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 2546

required :source_id, String

#source_type ⇒ Symbol, SafetyKit::Models::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest::SourceType

Coarse attribution category for the moderation decision source. Supported values: human_moderator (a human reviewer in your moderation workflow), expert_labeler (an expert human labeler or specialist reviewer), automation (an automated model, rules engine, or enforcement workflow), or vendor (an external review or moderation provider).

Returns:



2556
2557
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 2556

required :source_type,
enum: -> { SafetyKit::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest::SourceType }

#target_content_id ⇒ String?

Your stable identifier for the content being reported.

Returns:

  • (String, nil) 


2622
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 2622

optional :target_content_id, String

#target_user_id ⇒ String?

Your stable canonical identifier for the user being reported.

Returns:

  • (String, nil) 


2628
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 2628

optional :target_user_id, String

#timestamp ⇒ Time

The time the event occurred in your system, as an ISO 8601 datetime string.

Returns:

  • (Time) 


2563
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 2563

required :timestamp, Time

#type ⇒ Symbol, SafetyKit::Models::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest::Type

Returns:



2568
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 2568

required :type, enum: -> { SafetyKit::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest::Type }