Class: GetStream::Generated::Models::ActivityProcessingConfig

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/activity_processing_config.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

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

Constructor Details

#initialize(attributes = {}) ⇒ ActivityProcessingConfig

Initialize with attributes



23
24
25
26
27
28
 
# File 'lib/getstream_ruby/generated/models/activity_processing_config.rb', line 23

def initialize(attributes = {})
  super(attributes)
  @send_allowed_tags_to_ai = attributes[:send_allowed_tags_to_ai] || attributes['send_allowed_tags_to_ai'] || nil
  @allowed_tags = attributes[:allowed_tags] || attributes['allowed_tags'] || nil
  @blocked_tags = attributes[:blocked_tags] || attributes['blocked_tags'] || nil
end

Instance Attribute Details

#allowed_tags ⇒ Array<String>

Returns When set, the LLM activity processors may only write interest tags from this list. By default the model is not told about the list, so a tag is only written when the model happens to produce that exact word after lower-casing and trimming, which for any vocabulary is often not the case; set send_allowed_tags_to_ai to have the model choose from the list instead. Mutually exclusive with blocked_tags.

Returns:

  • (Array<String>) —

    When set, the LLM activity processors may only write interest tags from this list. By default the model is not told about the list, so a tag is only written when the model happens to produce that exact word after lower-casing and trimming, which for any vocabulary is often not the case; set send_allowed_tags_to_ai to have the model choose from the list instead. Mutually exclusive with blocked_tags.



17
18
19
 
# File 'lib/getstream_ruby/generated/models/activity_processing_config.rb', line 17

def allowed_tags
  @allowed_tags
end

#blocked_tags ⇒ Array<String>

Returns Interest tags the LLM activity processors are never allowed to write. Mutually exclusive with allowed_tags.

Returns:

  • (Array<String>) —

    Interest tags the LLM activity processors are never allowed to write. Mutually exclusive with allowed_tags.



20
21
22
 
# File 'lib/getstream_ruby/generated/models/activity_processing_config.rb', line 20

def blocked_tags
  @blocked_tags
end

#send_allowed_tags_to_ai ⇒ Boolean

Returns When true, this feed group's allowed_tags is given to the model as a constrained vocabulary so it maps its own wording onto a configured tag instead of that output being discarded. Improves how often a tag is produced, at the cost of sending the list on every request. Scoped to this group's own list: leaving it false keeps this group's tags out of the request even when another feed group on the same activity sets it true. Requires allowed_tags. Off by default.

Returns:

  • (Boolean) —

    When true, this feed group's allowed_tags is given to the model as a constrained vocabulary so it maps its own wording onto a configured tag instead of that output being discarded. Improves how often a tag is produced, at the cost of sending the list on every request. Scoped to this group's own list: leaving it false keeps this group's tags out of the request even when another feed group on the same activity sets it true. Requires allowed_tags. Off by default.



14
15
16
 
# File 'lib/getstream_ruby/generated/models/activity_processing_config.rb', line 14

def send_allowed_tags_to_ai
  @send_allowed_tags_to_ai
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



31
32
33
34
35
36
37
 
# File 'lib/getstream_ruby/generated/models/activity_processing_config.rb', line 31

def self.json_field_mappings
  {
    send_allowed_tags_to_ai: 'send_allowed_tags_to_ai',
    allowed_tags: 'allowed_tags',
    blocked_tags: 'blocked_tags'
  }
end