CreateEndpointDetails¶

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

Bases: object

The data to create an endpoint.

Methods:

__init__(**kwargs)

Initializes a new CreateEndpointDetails object with values from keyword arguments.

Attributes:

`compartment_id`	[Required] Gets the compartment_id of this CreateEndpointDetails.
`content_moderation_config`	Gets the content_moderation_config of this CreateEndpointDetails.
`dedicated_ai_cluster_id`	[Required] Gets the dedicated_ai_cluster_id of this CreateEndpointDetails.
`defined_tags`	Gets the defined_tags of this CreateEndpointDetails.
`description`	Gets the description of this CreateEndpointDetails.
`display_name`	Gets the display_name of this CreateEndpointDetails.
`freeform_tags`	Gets the freeform_tags of this CreateEndpointDetails.
`generative_ai_private_endpoint_id`	Gets the generative_ai_private_endpoint_id of this CreateEndpointDetails.
`model_id`	[Required] Gets the model_id of this CreateEndpointDetails.
`pii_detection_config`	Gets the pii_detection_config of this CreateEndpointDetails.
`prompt_injection_config`	Gets the prompt_injection_config of this CreateEndpointDetails.

__init__(**kwargs)¶

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

Parameters

display_name (str) – The value to assign to the display_name property of this CreateEndpointDetails.
description (str) – The value to assign to the description property of this CreateEndpointDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateEndpointDetails.
model_id (str) – The value to assign to the model_id property of this CreateEndpointDetails.
dedicated_ai_cluster_id (str) – The value to assign to the dedicated_ai_cluster_id property of this CreateEndpointDetails.
generative_ai_private_endpoint_id (str) – The value to assign to the generative_ai_private_endpoint_id property of this CreateEndpointDetails.
content_moderation_config (oci.generative_ai.models.ContentModerationConfig) – The value to assign to the content_moderation_config property of this CreateEndpointDetails.
prompt_injection_config (oci.generative_ai.models.PromptInjectionConfig) – The value to assign to the prompt_injection_config property of this CreateEndpointDetails.
pii_detection_config (oci.generative_ai.models.PiiDetectionConfig) – The value to assign to the pii_detection_config property of this CreateEndpointDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateEndpointDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateEndpointDetails.

property compartment_id¶

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

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

property content_moderation_config¶

Gets the content_moderation_config of this CreateEndpointDetails.

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

property dedicated_ai_cluster_id¶

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

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

property defined_tags¶

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

property description¶

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

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

property display_name¶

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

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

property freeform_tags¶

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

property generative_ai_private_endpoint_id¶

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

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

property model_id¶

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

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

property pii_detection_config¶

Gets the pii_detection_config of this CreateEndpointDetails.

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

property prompt_injection_config¶

Gets the prompt_injection_config of this CreateEndpointDetails.

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