Class: OCI::GoldenGate::Models::AiProviderSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/golden_gate/models/ai_provider_summary.rb

Overview

Summary details of an AI provider and its supported models.

Constant Summary collapse

PROVIDER_TYPE_ENUM = 
[
  PROVIDER_TYPE_OCI_GENERATIVE_AI = 'OCI_GENERATIVE_AI'.freeze,
  PROVIDER_TYPE_GEMINI = 'GEMINI'.freeze,
  PROVIDER_TYPE_OPEN_AI = 'OPEN_AI'.freeze,
  PROVIDER_TYPE_VOYAGE_AI = 'VOYAGE_AI'.freeze,
  PROVIDER_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AiProviderSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 94

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.provider_type = attributes[:'providerType'] if attributes[:'providerType']

  raise 'You cannot provide both :providerType and :provider_type' if attributes.key?(:'providerType') && attributes.key?(:'provider_type')

  self.provider_type = attributes[:'provider_type'] if attributes[:'provider_type']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.description = attributes[:'description'] if attributes[:'description']

  self.auth_type = attributes[:'authType'] if attributes[:'authType']

  raise 'You cannot provide both :authType and :auth_type' if attributes.key?(:'authType') && attributes.key?(:'auth_type')

  self.auth_type = attributes[:'auth_type'] if attributes[:'auth_type']

  self.default_base_url = attributes[:'defaultBaseUrl'] if attributes[:'defaultBaseUrl']

  raise 'You cannot provide both :defaultBaseUrl and :default_base_url' if attributes.key?(:'defaultBaseUrl') && attributes.key?(:'default_base_url')

  self.default_base_url = attributes[:'default_base_url'] if attributes[:'default_base_url']

  self.models = attributes[:'models'] if attributes[:'models']
end

Instance Attribute Details

#auth_type ⇒ Array<OCI::GoldenGate::Models::AiModelAuthType>

[Required] Authentication types supported by the AI provider.

Returns:

  • (Array<OCI::GoldenGate::Models::AiModelAuthType>) 


39
40
41
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 39

def auth_type
  @auth_type
end

#default_base_url ⇒ String

[Required] Default base URL for the AI provider.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 44

def default_base_url
  @default_base_url
end

#description ⇒ String

[Required] Metadata about this specific object.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 34

def description
  @description
end

#display_name ⇒ String

[Required] An object's Display Name.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 29

def display_name
  @display_name
end

#models ⇒ Array<OCI::GoldenGate::Models::AiModelSummary>

List of AI models supported by this provider, when available. This field is null when the provider's models can be retrieved only after supplying additional context. For example, OCI_GENERATIVE_AI model availability may vary by region.

Returns:



52
53
54
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 52

def models
  @models
end

#provider_type ⇒ String

[Required] AI Provider type used by the AI Model Connection.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 24

def provider_type
  @provider_type
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'provider_type': :'providerType',
    'display_name': :'displayName',
    'description': :'description',
    'auth_type': :'authType',
    'default_base_url': :'defaultBaseUrl',
    'models': :'models'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 69

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'provider_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'auth_type': :'Array<OCI::GoldenGate::Models::AiModelAuthType>',
    'default_base_url': :'String',
    'models': :'Array<OCI::GoldenGate::Models::AiModelSummary>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 149

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    provider_type == other.provider_type &&
    display_name == other.display_name &&
    description == other.description &&
    auth_type == other.auth_type &&
    default_base_url == other.default_base_url &&
    models == other.models
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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 184

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


164
165
166
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 164

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



173
174
175
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 173

def hash
  [provider_type, display_name, description, auth_type, default_base_url, models].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 217

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



211
212
213
 
# File 'lib/oci/golden_gate/models/ai_provider_summary.rb', line 211

def to_s
  to_hash.to_s
end