UpdateOcirModelDeploymentEnvironmentConfigurationDetails

class oci.data_science.models.UpdateOcirModelDeploymentEnvironmentConfigurationDetails(**kwargs)

Bases: UpdateModelDeploymentEnvironmentConfigurationDetails

The update environment configuration details object for OCI Registry

Attributes:

ENVIRONMENT_CONFIGURATION_TYPE_DEFAULT	A constant which can be used with the environment_configuration_type property of a UpdateModelDeploymentEnvironmentConfigurationDetails.
ENVIRONMENT_CONFIGURATION_TYPE_OCIR_CONTAINER	A constant which can be used with the environment_configuration_type property of a UpdateModelDeploymentEnvironmentConfigurationDetails.
cmd	Gets the cmd of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.
custom_http_endpoints	Gets the custom_http_endpoints of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.
entrypoint	Gets the entrypoint of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.
environment_configuration_type	[Required] Gets the environment_configuration_type of this UpdateModelDeploymentEnvironmentConfigurationDetails.
environment_variables	Gets the environment_variables of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.
health_check_port	Gets the health_check_port of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.
image	Gets the image of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.
image_digest	Gets the image_digest of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.
image_signature_id	Gets the image_signature_id of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.
predict_api_specification	Gets the predict_api_specification of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.
server_port	Gets the server_port of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

Methods:

__init__(**kwargs)	Initializes a new UpdateOcirModelDeploymentEnvironmentConfigurationDetails object with values from keyword arguments.
get_subtype(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

ENVIRONMENT_CONFIGURATION_TYPE_DEFAULT = 'DEFAULT'

A constant which can be used with the environment_configuration_type property of a UpdateModelDeploymentEnvironmentConfigurationDetails. This constant has a value of “DEFAULT”

ENVIRONMENT_CONFIGURATION_TYPE_OCIR_CONTAINER = 'OCIR_CONTAINER'

A constant which can be used with the environment_configuration_type property of a UpdateModelDeploymentEnvironmentConfigurationDetails. This constant has a value of “OCIR_CONTAINER”

__init__(**kwargs)

Initializes a new UpdateOcirModelDeploymentEnvironmentConfigurationDetails object with values from keyword arguments. The default value of the environment_configuration_type attribute of this class is OCIR_CONTAINER and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

• environment_configuration_type (str) – The value to assign to the environment_configuration_type property of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails. Allowed values for this property are: “DEFAULT”, “OCIR_CONTAINER”

• image (str) – The value to assign to the image property of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

• image_digest (str) – The value to assign to the image_digest property of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

• image_signature_id (str) – The value to assign to the image_signature_id property of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

• cmd (list[str]) – The value to assign to the cmd property of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

• entrypoint (list[str]) – The value to assign to the entrypoint property of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

• server_port (int) – The value to assign to the server_port property of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

• health_check_port (int) – The value to assign to the health_check_port property of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

• environment_variables (dict(str, str)) – The value to assign to the environment_variables property of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

• predict_api_specification (str) – The value to assign to the predict_api_specification property of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

• custom_http_endpoints (list[oci.data_science.models.InferenceHttpEndpoint]) – The value to assign to the custom_http_endpoints property of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

property cmd

Gets the cmd of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails. The container image run CMD as a list of strings. Use CMD as arguments to the ENTRYPOINT or the only command to run in the absence of an ENTRYPOINT. The combined size of CMD and ENTRYPOINT must be less than 2048 bytes.

Returns

The cmd of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

Return type

list[str]

property custom_http_endpoints

Gets the custom_http_endpoints of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails. List of custom inference HTTP endpoints configured on the model deployment instance for inferencing.

Returns

The custom_http_endpoints of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

Return type

list[oci.data_science.models.InferenceHttpEndpoint]

property entrypoint

Gets the entrypoint of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails. The container image run ENTRYPOINT as a list of strings. Accept the CMD as extra arguments. The combined size of CMD and ENTRYPOINT must be less than 2048 bytes. More information on how CMD and ENTRYPOINT interact are here.

Returns

The entrypoint of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

Return type

list[str]

property environment_configuration_type

[Required] Gets the environment_configuration_type of this UpdateModelDeploymentEnvironmentConfigurationDetails. The environment configuration type

Allowed values for this property are: “DEFAULT”, “OCIR_CONTAINER”

Returns

The environment_configuration_type of this UpdateModelDeploymentEnvironmentConfigurationDetails.

Return type

str

property environment_variables

Gets the environment_variables of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails. Environment variables to set for the web server container. The size of envVars must be less than 2048 bytes. Key should be under 32 characters. Key should contain only letters, digits and underscore (_) Key should start with a letter. Key should have at least 2 characters. Key should not end with underscore eg. TEST_ Key if added cannot be empty. Value can be empty. No specific size limits on individual Values. But overall environment variables is limited to 2048 bytes. Key can’t be reserved Model Deployment environment variables.

Returns

The environment_variables of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

Return type

dict(str, str)

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property health_check_port

Gets the health_check_port of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails. The port on which the container HEALTHCHECK would listen. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.

Returns

The health_check_port of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

Return type

int

property image

Gets the image of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails. The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: <region>.ocir.io/<registry>/<image>:<tag> <region>.ocir.io/<registry>/<image>:<tag>@digest

Returns

The image of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

Return type

str

property image_digest

Gets the image_digest of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails. The digest of the container image. For example, sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030

Returns

The image_digest of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

Return type

str

property image_signature_id

Gets the image_signature_id of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails. OCID of the container image signature

Returns

The image_signature_id of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

Return type

str

property predict_api_specification

Gets the predict_api_specification of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails. The chosen specification from predefined set of endpoints a user can access. For example, if the value is ‘openai’, the user can access OpenAI-compliant endpoints like /v1/completions, /v1/chat/completions, /v1/models, etc., for inference.

Returns

The predict_api_specification of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

Return type

str

property server_port

Gets the server_port of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails. The port on which the web server serving the inference is running. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.

Returns

The server_port of this UpdateOcirModelDeploymentEnvironmentConfigurationDetails.

Return type

int