Class: Vellum::ExternalParentContext

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/types/external_parent_context.rb

Constant Summary collapse

OMIT =
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(parent: OMIT, links: OMIT, type:, span_id:, additional_properties: nil) ⇒ Vellum::ExternalParentContext

Parameters:

  • parent (Vellum::ParentContext) (defaults to: OMIT)
  • links (Array<Vellum::SpanLink>) (defaults to: OMIT)
  • type (String)
  • span_id (String)
  • additional_properties (OpenStruct) (defaults to: nil)

    Additional properties unmapped to the current class definition



31
32
33
34
35
36
37
38
39
40
# File 'lib/vellum_ai/types/external_parent_context.rb', line 31

def initialize(parent: OMIT, links: OMIT, type:, span_id:, additional_properties: nil)
  @parent = parent if parent != OMIT
  @links = links if links != OMIT
  @type = type
  @span_id = span_id
  @additional_properties = additional_properties
  @_field_set = { "parent": parent, "links": links, "type": type, "span_id": span_id }.reject do | _k, v |
  v == OMIT
end
end

Instance Attribute Details

#additional_propertiesOpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct)

    Additional properties unmapped to the current class definition



18
19
20
# File 'lib/vellum_ai/types/external_parent_context.rb', line 18

def additional_properties
  @additional_properties
end

Returns:



12
13
14
# File 'lib/vellum_ai/types/external_parent_context.rb', line 12

def links
  @links
end

#parentVellum::ParentContext (readonly)



10
11
12
# File 'lib/vellum_ai/types/external_parent_context.rb', line 10

def parent
  @parent
end

#span_idString (readonly)

Returns:

  • (String)


16
17
18
# File 'lib/vellum_ai/types/external_parent_context.rb', line 16

def span_id
  @span_id
end

#typeString (readonly)

Returns:

  • (String)


14
15
16
# File 'lib/vellum_ai/types/external_parent_context.rb', line 14

def type
  @type
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::ExternalParentContext

Parameters:

  • json_object (String)

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/vellum_ai/types/external_parent_context.rb', line 45

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  unless parsed_json["parent"].nil?
    parent = parsed_json["parent"].to_json
    parent = Vellum::ParentContext.from_json(json_object: parent)
  else
    parent = nil
  end
  links = parsed_json["links"]&.map do | item |
  item = item.to_json
  Vellum::SpanLink.from_json(json_object: item)
end
  type = parsed_json["type"]
  span_id = parsed_json["span_id"]
  new(
    parent: parent,
    links: links,
    type: type,
    span_id: span_id,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void)


80
81
82
83
84
85
# File 'lib/vellum_ai/types/external_parent_context.rb', line 80

def self.validate_raw(obj:)
  obj.parent.nil? || Vellum::ParentContext.validate_raw(obj: obj.parent)
  obj.links&.is_a?(Array) != false || raise("Passed value for field obj.links is not the expected type, validation failed.")
  obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
  obj.span_id.is_a?(String) != false || raise("Passed value for field obj.span_id is not the expected type, validation failed.")
end

Instance Method Details

#to_jsonString

Returns:

  • (String)


71
72
73
# File 'lib/vellum_ai/types/external_parent_context.rb', line 71

def to_json
  @_field_set&.to_json
end