Class: OpenApiOpenAIClient::CreateEmbeddingRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ CreateEmbeddingRequest

Initializes the object



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 93

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::CreateEmbeddingRequest` 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::CreateEmbeddingRequest`. 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?(:'input')
    self.input = attributes[:'input']
  else
    self.input = nil
  end

  if attributes.key?(:'model')
    self.model = attributes[:'model']
  else
    self.model = nil
  end

  if attributes.key?(:'encoding_format')
    self.encoding_format = attributes[:'encoding_format']
  else
    self.encoding_format = 'float'
  end

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

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

Instance Attribute Details

#dimensions ⇒ Object

The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.



26
27
28
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 26

def dimensions
  @dimensions
end

#encoding_format ⇒ Object

The format to return the embeddings in. Can be either float or [base64](pypi.org/project/pybase64/).



23
24
25
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 23

def encoding_format
  @encoding_format
end

#input ⇒ Object

Returns the value of attribute input.



18
19
20
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 18

def input
  @input
end

#model ⇒ Object

Returns the value of attribute model.



20
21
22
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 20

def model
  @model
end

#user ⇒ Object

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).



29
30
31
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 29

def user
  @user
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



65
66
67
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 65

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 70

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 54

def self.attribute_map
  {
    :'input' => :'input',
    :'model' => :'model',
    :'encoding_format' => :'encoding_format',
    :'dimensions' => :'dimensions',
    :'user' => :'user'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 237

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



86
87
88
89
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 86

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

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 75

def self.openapi_types
  {
    :'input' => :'CreateEmbeddingRequestInput',
    :'model' => :'CreateEmbeddingRequestModel',
    :'encoding_format' => :'String',
    :'dimensions' => :'Integer',
    :'user' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



212
213
214
215
216
217
218
219
220
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      input == o.input &&
      model == o.model &&
      encoding_format == o.encoding_format &&
      dimensions == o.dimensions &&
      user == o.user
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


224
225
226
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



230
231
232
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 230

def hash
  [input, model, encoding_format, dimensions, user].hash
end

#list_invalid_properties ⇒ Object

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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 136

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @input.nil?
    invalid_properties.push('invalid value for "input", input cannot be nil.')
  end

  if @model.nil?
    invalid_properties.push('invalid value for "model", model cannot be nil.')
  end

  if !@dimensions.nil? && @dimensions < 1
    invalid_properties.push('invalid value for "dimensions", must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 259

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



156
157
158
159
160
161
162
163
164
 
# File 'lib/openapi_openai/models/create_embedding_request.rb', line 156

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @input.nil?
  return false if @model.nil?
  encoding_format_validator = EnumAttributeValidator.new('String', ["float", "base64"])
  return false unless encoding_format_validator.valid?(@encoding_format)
  return false if !@dimensions.nil? && @dimensions < 1
  true
end