Class: GetStream::Generated::Models::AnalyzeTextField

Inherits:

BaseModel

• Object
• BaseModel
• GetStream::Generated::Models::AnalyzeTextField

Defined in:

lib/getstream_ruby/generated/models/analyze_text_field.rb

Instance Attribute Summary

• #action ⇒ String

  Per-field action: keep | flag | remove.

• #classifications ⇒ Array<Classification>

  Flat list of detected Bodyguard text labels (e.g. INSULT, VULGARITY).

• #error ⇒ String

  Set when moderation couldn't be determined for this field — action is absent.

• #id ⇒ String

  Echo of content_ids[label] when supplied on the request; omitted otherwise.

• #language ⇒ String

  Detected language code.

• #severity ⇒ String

  Aggregate severity across the field: LOW | MEDIUM | HIGH | CRITICAL.

Class Method Summary

• .json_field_mappings ⇒ Object

  Override field mappings for JSON serialization.

Instance Method Summary

• #initialize(attributes = {}) ⇒ AnalyzeTextField constructor

  Initialize with attributes.

Methods inherited from BaseModel

#==, #inspect, omit_empty_fields, #to_h, #to_json

Constructor Details

#initialize(attributes = {}) ⇒ AnalyzeTextField

Initialize with attributes

# File 'lib/getstream_ruby/generated/models/analyze_text_field.rb', line 32

def initialize(attributes = {})
  super(attributes)
  @action = attributes[:action] || attributes['action'] || nil
  @error = attributes[:error] || attributes['error'] || nil
  @id = attributes[:id] || attributes['id'] || nil
  @language = attributes[:language] || attributes['language'] || nil
  @severity = attributes[:severity] || attributes['severity'] || nil
  @classifications = attributes[:classifications] || attributes['classifications'] || nil
end

Instance Attribute Details

#action ⇒ String

# File 'lib/getstream_ruby/generated/models/analyze_text_field.rb', line 14

def action
  @action
end

#classifications ⇒ Array<Classification>

# File 'lib/getstream_ruby/generated/models/analyze_text_field.rb', line 29

def classifications
  @classifications
end

#error ⇒ String

# File 'lib/getstream_ruby/generated/models/analyze_text_field.rb', line 17

def error
  @error
end

#id ⇒ String

# File 'lib/getstream_ruby/generated/models/analyze_text_field.rb', line 20

def id
  @id
end

#language ⇒ String

# File 'lib/getstream_ruby/generated/models/analyze_text_field.rb', line 23

def language
  @language
end

#severity ⇒ String

# File 'lib/getstream_ruby/generated/models/analyze_text_field.rb', line 26

def severity
  @severity
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization

# File 'lib/getstream_ruby/generated/models/analyze_text_field.rb', line 43

def self.json_field_mappings
  {
    action: 'action',
    error: 'error',
    id: 'id',
    language: 'language',
    severity: 'severity',
    classifications: 'classifications'
  }
end