Class: OpenApiOpenAIClient::AssistantObjectToolResources

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/openapi_openai/models/assistant_object_tool_resources.rb

Overview

A set of resources that are used by the assistant’s tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ AssistantObjectToolResources

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 57

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::AssistantObjectToolResources` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::AssistantObjectToolResources`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'code_interpreter')
    self.code_interpreter = attributes[:'code_interpreter']
  end

  if attributes.key?(:'file_search')
    self.file_search = attributes[:'file_search']
  end
end

Instance Attribute Details

#code_interpreter ⇒ Object

Returns the value of attribute code_interpreter.



19
20
21
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 19

def code_interpreter
  @code_interpreter
end

#file_search ⇒ Object

Returns the value of attribute file_search.



21
22
23
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 21

def file_search
  @file_search
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



32
33
34
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 32

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



37
38
39
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 37

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



24
25
26
27
28
29
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 24

def self.attribute_map
  {
    :'code_interpreter' => :'code_interpreter',
    :'file_search' => :'file_search'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 119

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



50
51
52
53
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 50

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 42

def self.openapi_types
  {
    :'code_interpreter' => :'AssistantObjectToolResourcesCodeInterpreter',
    :'file_search' => :'AssistantObjectToolResourcesFileSearch'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



97
98
99
100
101
102
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 97

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code_interpreter == o.code_interpreter &&
      file_search == o.file_search
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


106
107
108
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 106

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



112
113
114
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 112

def hash
  [code_interpreter, file_search].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



82
83
84
85
86
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 82

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 141

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



90
91
92
93
 
# File 'lib/openapi_openai/models/assistant_object_tool_resources.rb', line 90

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end