Endpoint¶

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

Bases: object

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 Resources.

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Endpoint.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Endpoint.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Endpoint.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Endpoint.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Endpoint.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Endpoint.
`compartment_id`	[Required] Gets the compartment_id of this Endpoint.
`content_moderation_config`	Gets the content_moderation_config of this Endpoint.
`dedicated_ai_cluster_id`	[Required] Gets the dedicated_ai_cluster_id of this Endpoint.
`defined_tags`	Gets the defined_tags of this Endpoint.
`description`	Gets the description of this Endpoint.
`display_name`	Gets the display_name of this Endpoint.
`freeform_tags`	Gets the freeform_tags of this Endpoint.
`generative_ai_private_endpoint_id`	Gets the generative_ai_private_endpoint_id of this Endpoint.
`id`	[Required] Gets the id of this Endpoint.
`lifecycle_details`	Gets the lifecycle_details of this Endpoint.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Endpoint.
`model_id`	[Required] Gets the model_id of this Endpoint.
`pii_detection_config`	Gets the pii_detection_config of this Endpoint.
`previous_state`	Gets the previous_state of this Endpoint.
`prompt_injection_config`	Gets the prompt_injection_config of this Endpoint.
`system_tags`	Gets the system_tags of this Endpoint.
`time_created`	[Required] Gets the time_created of this Endpoint.
`time_updated`	Gets the time_updated of this Endpoint.

Methods:

__init__(**kwargs)

Initializes a new Endpoint object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Endpoint. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Endpoint. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Endpoint. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Endpoint. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Endpoint. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Endpoint. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new Endpoint 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 Endpoint.
display_name (str) – The value to assign to the display_name property of this Endpoint.
description (str) – The value to assign to the description property of this Endpoint.
model_id (str) – The value to assign to the model_id property of this Endpoint.
compartment_id (str) – The value to assign to the compartment_id property of this Endpoint.
dedicated_ai_cluster_id (str) – The value to assign to the dedicated_ai_cluster_id property of this Endpoint.
generative_ai_private_endpoint_id (str) – The value to assign to the generative_ai_private_endpoint_id property of this Endpoint.
time_created (datetime) – The value to assign to the time_created property of this Endpoint.
time_updated (datetime) – The value to assign to the time_updated property of this Endpoint.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Endpoint. Allowed values for this property are: “ACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this Endpoint.
content_moderation_config (oci.generative_ai.models.ContentModerationConfig) – The value to assign to the content_moderation_config property of this Endpoint.
prompt_injection_config (oci.generative_ai.models.PromptInjectionConfig) – The value to assign to the prompt_injection_config property of this Endpoint.
pii_detection_config (oci.generative_ai.models.PiiDetectionConfig) – The value to assign to the pii_detection_config property of this Endpoint.
previous_state (oci.generative_ai.models.Endpoint) – The value to assign to the previous_state property of this Endpoint.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Endpoint.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Endpoint.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Endpoint.

property compartment_id¶

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

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

property content_moderation_config¶

Gets the content_moderation_config of this Endpoint.

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

property dedicated_ai_cluster_id¶

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

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

property defined_tags¶

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

property description¶

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

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

property display_name¶

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

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

property freeform_tags¶

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

property generative_ai_private_endpoint_id¶

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

Returns: The generative_ai_private_endpoint_id of this Endpoint.
Return type: str

property id¶

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

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

property lifecycle_details¶

Gets the lifecycle_details of this Endpoint. A message describing the current state of the endpoint in more detail that can provide actionable information.

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

property lifecycle_state¶

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

Allowed values for this property are: “ACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

property model_id¶

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

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

property pii_detection_config¶

Gets the pii_detection_config of this Endpoint.

Returns: The pii_detection_config of this Endpoint.
Return type: oci.generative_ai.models.PiiDetectionConfig

property previous_state¶

Gets the previous_state of this Endpoint.

Returns: The previous_state of this Endpoint.
Return type: oci.generative_ai.models.Endpoint

property prompt_injection_config¶

Gets the prompt_injection_config of this Endpoint.

Returns: The prompt_injection_config of this Endpoint.
Return type: oci.generative_ai.models.PromptInjectionConfig

property system_tags¶

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

property time_created¶

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

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

property time_updated¶

Gets the time_updated of this Endpoint. The date and time that the endpoint was updated in the format of an RFC3339 datetime string.

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