Class: Akeyless::OpenAITargetDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/akeyless/models/open_ai_target_details.rb

Overview

OpenAITargetDetails defines details related to connecting to an OpenAI provider

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OpenAITargetDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



89
90
91
92
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
133
134
135
136
137
138
139
140
141
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 89

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#api_key ⇒ Object

Returns the value of attribute api_key.



19
20
21
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 19

def api_key
  @api_key
end

#api_key_id ⇒ Object

Returns the value of attribute api_key_id.



21
22
23
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 21

def api_key_id
  @api_key_id
end

#auth_mode ⇒ Object

AuthMode selects how this target authenticates. Empty (default) uses ApiKey as a static bearer token against BaseURL, matching all pre-existing behavior. OpenAIAuthModeChatGPTOAuth instead uses the OAuth* fields below.



24
25
26
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 24

def auth_mode
  @auth_mode
end

#oauth_access_token ⇒ Object

OAuthAccessToken is the current ChatGPT-issued access token (the tokens.access_token field of the customer's local auth.json). Akeyless refreshes this automatically; do not treat it as long-lived.



27
28
29
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 27

def oauth_access_token
  @oauth_access_token
end

#oauth_account_id ⇒ Object

OAuthAccountID is the ChatGPT workspace/account id (tokens.account_id in auth.json), required on every request to the ChatGPT backend.



30
31
32
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 30

def 
  @oauth_account_id
end

#oauth_last_refresh ⇒ Object

OAuthLastRefresh is the RFC3339 timestamp of the last successful Akeyless-performed refresh; used as a fallback expiry heuristic when the access token's JWT exp claim can't be parsed.



33
34
35
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 33

def oauth_last_refresh
  @oauth_last_refresh
end

#oauth_refresh_token ⇒ Object

OAuthRefreshToken mints new access tokens. It rotates on every refresh - Akeyless persists the new value after each successful refresh, so the previous value becomes invalid.



36
37
38
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 36

def oauth_refresh_token
  @oauth_refresh_token
end

#openai_url ⇒ Object

Returns the value of attribute openai_url.



38
39
40
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 38

def openai_url
  @openai_url
end

#organization_id ⇒ Object

Returns the value of attribute organization_id.



40
41
42
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 40

def organization_id
  @organization_id
end

#project_id ⇒ Object

Returns the value of attribute project_id.



42
43
44
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 42

def project_id
  @project_id
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 214

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Akeyless.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 45

def self.attribute_map
  {
    :'api_key' => :'api_key',
    :'api_key_id' => :'api_key_id',
    :'auth_mode' => :'auth_mode',
    :'oauth_access_token' => :'oauth_access_token',
    :'oauth_account_id' => :'oauth_account_id',
    :'oauth_last_refresh' => :'oauth_last_refresh',
    :'oauth_refresh_token' => :'oauth_refresh_token',
    :'openai_url' => :'openai_url',
    :'organization_id' => :'organization_id',
    :'project_id' => :'project_id'
  }
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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 190

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



82
83
84
85
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 82

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 66

def self.openapi_types
  {
    :'api_key' => :'String',
    :'api_key_id' => :'String',
    :'auth_mode' => :'String',
    :'oauth_access_token' => :'String',
    :'oauth_account_id' => :'String',
    :'oauth_last_refresh' => :'String',
    :'oauth_refresh_token' => :'String',
    :'openai_url' => :'String',
    :'organization_id' => :'String',
    :'project_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 160

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      api_key == o.api_key &&
      api_key_id == o.api_key_id &&
      auth_mode == o.auth_mode &&
      oauth_access_token == o.oauth_access_token &&
       == o. &&
      oauth_last_refresh == o.oauth_last_refresh &&
      oauth_refresh_token == o.oauth_refresh_token &&
      openai_url == o.openai_url &&
      organization_id == o.organization_id &&
      project_id == o.project_id
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 285

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


177
178
179
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 177

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



183
184
185
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 183

def hash
  [api_key, api_key_id, auth_mode, oauth_access_token, , oauth_last_refresh, oauth_refresh_token, openai_url, organization_id, project_id].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



145
146
147
148
149
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 145

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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



261
262
263
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 261

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 267

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



255
256
257
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 255

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



153
154
155
156
 
# File 'lib/akeyless/models/open_ai_target_details.rb', line 153

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