Class: OCI::GenerativeAi::Models::CreateEndpointDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai/models/create_endpoint_details.rb

Overview

The data to create an endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateEndpointDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 115

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.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.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.model_id = attributes[:'modelId'] if attributes[:'modelId']

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

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

  self.dedicated_ai_cluster_id = attributes[:'dedicatedAiClusterId'] if attributes[:'dedicatedAiClusterId']

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

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

  self.generative_ai_private_endpoint_id = attributes[:'generativeAiPrivateEndpointId'] if attributes[:'generativeAiPrivateEndpointId']

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

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

  self.content_moderation_config = attributes[:'contentModerationConfig'] if attributes[:'contentModerationConfig']

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

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

  self.prompt_injection_config = attributes[:'promptInjectionConfig'] if attributes[:'promptInjectionConfig']

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

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

  self.pii_detection_config = attributes[:'piiDetectionConfig'] if attributes[:'piiDetectionConfig']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The compartment OCID to create the endpoint in.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 21

def compartment_id
  @compartment_id
end

#content_moderation_config ⇒ OCI::GenerativeAi::Models::ContentModerationConfig

Returns:



36
37
38
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 36

def content_moderation_config
  @content_moderation_config
end

#dedicated_ai_cluster_id ⇒ String

[Required] The OCID of the dedicated AI cluster on which a model will be deployed to.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 29

def dedicated_ai_cluster_id
  @dedicated_ai_cluster_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


58
59
60
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 58

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the endpoint.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 17

def description
  @description
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 13

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


50
51
52
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 50

def freeform_tags
  @freeform_tags
end

#generative_ai_private_endpoint_id ⇒ String

The OCID of the Generative AI private endpoint to which this endpoint is attached to.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 33

def generative_ai_private_endpoint_id
  @generative_ai_private_endpoint_id
end

#model_id ⇒ String

[Required] The OCID of the model that's used to create this endpoint.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 25

def model_id
  @model_id
end

#pii_detection_config ⇒ OCI::GenerativeAi::Models::PiiDetectionConfig

Returns:



42
43
44
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 42

def pii_detection_config
  @pii_detection_config
end

#prompt_injection_config ⇒ OCI::GenerativeAi::Models::PromptInjectionConfig

Returns:



39
40
41
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 39

def prompt_injection_config
  @prompt_injection_config
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 61

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'model_id': :'modelId',
    'dedicated_ai_cluster_id': :'dedicatedAiClusterId',
    'generative_ai_private_endpoint_id': :'generativeAiPrivateEndpointId',
    'content_moderation_config': :'contentModerationConfig',
    'prompt_injection_config': :'promptInjectionConfig',
    'pii_detection_config': :'piiDetectionConfig',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 80

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'model_id': :'String',
    'dedicated_ai_cluster_id': :'String',
    'generative_ai_private_endpoint_id': :'String',
    'content_moderation_config': :'OCI::GenerativeAi::Models::ContentModerationConfig',
    'prompt_injection_config': :'OCI::GenerativeAi::Models::PromptInjectionConfig',
    'pii_detection_config': :'OCI::GenerativeAi::Models::PiiDetectionConfig',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 191

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    model_id == other.model_id &&
    dedicated_ai_cluster_id == other.dedicated_ai_cluster_id &&
    generative_ai_private_endpoint_id == other.generative_ai_private_endpoint_id &&
    content_moderation_config == other.content_moderation_config &&
    prompt_injection_config == other.prompt_injection_config &&
    pii_detection_config == other.pii_detection_config &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 231

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


211
212
213
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 211

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



220
221
222
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 220

def hash
  [display_name, description, compartment_id, model_id, dedicated_ai_cluster_id, generative_ai_private_endpoint_id, content_moderation_config, prompt_injection_config, pii_detection_config, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



264
265
266
267
268
269
270
271
272
273
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 264

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



258
259
260
 
# File 'lib/oci/generative_ai/models/create_endpoint_details.rb', line 258

def to_s
  to_hash.to_s
end