Class: OCI::GenerativeAi::Models::Endpoint
- Inherits:
-
Object
- Object
- OCI::GenerativeAi::Models::Endpoint
- Defined in:
- lib/oci/generative_ai/models/endpoint.rb
Overview
To host a custom model for inference, create an endpoint for that model on a dedicated AI cluster of type HOSTING.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies and Getting Access to Generative AI Resouces.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The compartment OCID to create the endpoint in.
- #content_moderation_config ⇒ OCI::GenerativeAi::Models::ContentModerationConfig
-
#dedicated_ai_cluster_id ⇒ String
[Required] The OCID of the dedicated AI cluster on which the model will be deployed to.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
An optional description of the endpoint.
-
#display_name ⇒ String
A user-friendly name.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] An OCID that uniquely identifies this endpoint resource.
-
#lifecycle_details ⇒ String
A message describing the current state of the endpoint in more detail that can provide actionable information.
-
#lifecycle_state ⇒ String
[Required] The current state of the endpoint.
-
#model_id ⇒ String
[Required] The OCID of the model that's used to create this endpoint.
- #previous_state ⇒ OCI::GenerativeAi::Models::Endpoint
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource.
-
#time_created ⇒ DateTime
[Required] The date and time that the endpoint was created in the format of an RFC3339 datetime string.
-
#time_updated ⇒ DateTime
The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Endpoint
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Endpoint
Initializes the object
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 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 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 162 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.id = attributes[:'id'] if attributes[:'id'] 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.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.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.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.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated'] raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated') self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails'] raise 'You cannot provide both :lifecycleDetails and :lifecycle_details' if attributes.key?(:'lifecycleDetails') && attributes.key?(:'lifecycle_details') self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details'] 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.previous_state = attributes[:'previousState'] if attributes[:'previousState'] raise 'You cannot provide both :previousState and :previous_state' if attributes.key?(:'previousState') && attributes.key?(:'previous_state') self.previous_state = attributes[:'previous_state'] if attributes[:'previous_state'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = attributes[:'system_tags'] if attributes[:'system_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The compartment OCID to create the endpoint in.
44 45 46 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 44 def compartment_id @compartment_id end |
#content_moderation_config ⇒ OCI::GenerativeAi::Models::ContentModerationConfig
67 68 69 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 67 def content_moderation_config @content_moderation_config end |
#dedicated_ai_cluster_id ⇒ String
[Required] The OCID of the dedicated AI cluster on which the model will be deployed to.
48 49 50 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 48 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\"}}
86 87 88 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 86 def @defined_tags end |
#description ⇒ String
An optional description of the endpoint.
36 37 38 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 36 def description @description end |
#display_name ⇒ String
A user-friendly name. Does not have to be unique, and it's changeable.
32 33 34 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 32 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\"}
78 79 80 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 78 def @freeform_tags end |
#id ⇒ String
[Required] An OCID that uniquely identifies this endpoint resource.
28 29 30 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 28 def id @id end |
#lifecycle_details ⇒ String
A message describing the current state of the endpoint in more detail that can provide actionable information.
64 65 66 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 64 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The current state of the endpoint.
60 61 62 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 60 def lifecycle_state @lifecycle_state end |
#model_id ⇒ String
[Required] The OCID of the model that's used to create this endpoint.
40 41 42 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 40 def model_id @model_id end |
#previous_state ⇒ OCI::GenerativeAi::Models::Endpoint
70 71 72 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 70 def previous_state @previous_state end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}
93 94 95 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 93 def @system_tags end |
#time_created ⇒ DateTime
[Required] The date and time that the endpoint was created in the format of an RFC3339 datetime string.
52 53 54 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 52 def time_created @time_created end |
#time_updated ⇒ DateTime
The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
56 57 58 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 56 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 96 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'description': :'description', 'model_id': :'modelId', 'compartment_id': :'compartmentId', 'dedicated_ai_cluster_id': :'dedicatedAiClusterId', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'content_moderation_config': :'contentModerationConfig', 'previous_state': :'previousState', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 119 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'description': :'String', 'model_id': :'String', 'compartment_id': :'String', 'dedicated_ai_cluster_id': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'content_moderation_config': :'OCI::GenerativeAi::Models::ContentModerationConfig', 'previous_state': :'OCI::GenerativeAi::Models::Endpoint', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 271 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && description == other.description && model_id == other.model_id && compartment_id == other.compartment_id && dedicated_ai_cluster_id == other.dedicated_ai_cluster_id && time_created == other.time_created && time_updated == other.time_updated && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && content_moderation_config == other.content_moderation_config && previous_state == other.previous_state && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 315 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
295 296 297 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 295 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
304 305 306 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 304 def hash [id, display_name, description, model_id, compartment_id, dedicated_ai_cluster_id, time_created, time_updated, lifecycle_state, lifecycle_details, content_moderation_config, previous_state, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
348 349 350 351 352 353 354 355 356 357 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 348 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
342 343 344 |
# File 'lib/oci/generative_ai/models/endpoint.rb', line 342 def to_s to_hash.to_s end |