Class: LLM::Function::Return

Inherits:
Struct
  • Object
show all
Defined in:
lib/llm/function.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#id ⇒ Object

Returns the value of attribute id

Returns:

  • (Object) —

    the current value of id



45
46
47
 
# File 'lib/llm/function.rb', line 45

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name

Returns:

  • (Object) —

    the current value of name



45
46
47
 
# File 'lib/llm/function.rb', line 45

def name
  @name
end

#value ⇒ Object

Returns the value of attribute value

Returns:

  • (Object) —

    the current value of value



45
46
47
 
# File 'lib/llm/function.rb', line 45

def value
  @value
end

Instance Method Details

#error? ⇒ Boolean

Returns true when the return value represents an error.

Returns:

  • (Boolean) 


49
50
51
 
# File 'lib/llm/function.rb', line 49

def error?
  Hash === value && value[:error] == true
end

#to_h ⇒ Hash

Returns a Hash representation of LLM::Function::Return

Returns:

  • (Hash) 


56
57
58
 
# File 'lib/llm/function.rb', line 56

def to_h
  {id:, name:, value:}
end

#to_json ⇒ String

Returns:

  • (String) 


62
63
64
 
# File 'lib/llm/function.rb', line 62

def to_json(...)
  LLM.json.dump(to_h, ...)
end