EndpointSummary¶

class oci.generative_ai.models.EndpointSummary(**kwargs)¶

Bases: object

Summary information for an endpoint resource.

Methods

__init__(**kwargs) Initializes a new EndpointSummary object with values from keyword arguments.

Attributes

`compartment_id`	[Required] Gets the compartment_id of this EndpointSummary.
`content_moderation_config`	Gets the content_moderation_config of this EndpointSummary.
`dedicated_ai_cluster_id`	[Required] Gets the dedicated_ai_cluster_id of this EndpointSummary.
`defined_tags`	Gets the defined_tags of this EndpointSummary.
`description`	Gets the description of this EndpointSummary.
`display_name`	Gets the display_name of this EndpointSummary.
`freeform_tags`	Gets the freeform_tags of this EndpointSummary.
`id`	[Required] Gets the id of this EndpointSummary.
`lifecycle_details`	Gets the lifecycle_details of this EndpointSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this EndpointSummary.
`model_id`	[Required] Gets the model_id of this EndpointSummary.
`system_tags`	Gets the system_tags of this EndpointSummary.
`time_created`	[Required] Gets the time_created of this EndpointSummary.
`time_updated`	Gets the time_updated of this EndpointSummary.

__init__(**kwargs)¶

Initializes a new EndpointSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this EndpointSummary.
display_name (str) – The value to assign to the display_name property of this EndpointSummary.
description (str) – The value to assign to the description property of this EndpointSummary.
model_id (str) – The value to assign to the model_id property of this EndpointSummary.
compartment_id (str) – The value to assign to the compartment_id property of this EndpointSummary.
dedicated_ai_cluster_id (str) – The value to assign to the dedicated_ai_cluster_id property of this EndpointSummary.
time_created (datetime) – The value to assign to the time_created property of this EndpointSummary.
time_updated (datetime) – The value to assign to the time_updated property of this EndpointSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this EndpointSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this EndpointSummary.
content_moderation_config (oci.generative_ai.models.ContentModerationConfig) – The value to assign to the content_moderation_config property of this EndpointSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this EndpointSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this EndpointSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this EndpointSummary.

compartment_id¶

[Required] Gets the compartment_id of this EndpointSummary. The compartment OCID to create the endpoint in.

Returns:	The compartment_id of this EndpointSummary.
Return type:	str

content_moderation_config¶

Gets the content_moderation_config of this EndpointSummary.

Returns:	The content_moderation_config of this EndpointSummary.
Return type:	oci.generative_ai.models.ContentModerationConfig

dedicated_ai_cluster_id¶

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

Returns:	The dedicated_ai_cluster_id of this EndpointSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this EndpointSummary. 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:	The defined_tags of this EndpointSummary.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this EndpointSummary. An optional description of the endpoint.

Returns:	The description of this EndpointSummary.
Return type:	str

display_name¶

Gets the display_name of this EndpointSummary. A user-friendly name. Does not have to be unique, and it’s changeable.

Returns:	The display_name of this EndpointSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this EndpointSummary. 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:	The freeform_tags of this EndpointSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this EndpointSummary. An OCID that uniquely identifies this endpoint resource.

Returns:	The id of this EndpointSummary.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this EndpointSummary. A message describing the current state with detail that can provide actionable information.

Returns:	The lifecycle_details of this EndpointSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this EndpointSummary. The current state of the endpoint.

Allowed values are: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED

Returns:	The lifecycle_state of this EndpointSummary.
Return type:	str

model_id¶

[Required] Gets the model_id of this EndpointSummary. The OCID of the model that’s used to create this endpoint.

Returns:	The model_id of this EndpointSummary.
Return type:	str

system_tags¶

Gets the system_tags of this EndpointSummary. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this EndpointSummary.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this EndpointSummary. The date and time that the endpoint was created in the format of an RFC3339 datetime string.

Returns:	The time_created of this EndpointSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this EndpointSummary. The date and time the endpoint was updated in the format of n RFC3339 datetime string.

Returns:	The time_updated of this EndpointSummary.
Return type:	datetime