CreateEndpointDetails¶

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

Bases: object

The information needed to create a new endpoint and expose to end users.

Attributes

`COMPUTE_TYPE_CPU`	A constant which can be used with the compute_type property of a CreateEndpointDetails.
`COMPUTE_TYPE_GPU`	A constant which can be used with the compute_type property of a CreateEndpointDetails.
`alias`	Gets the alias of this CreateEndpointDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateEndpointDetails.
`compute_type`	Gets the compute_type 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.
`inference_units`	Gets the inference_units of this CreateEndpointDetails.
`model_id`	[Required] Gets the model_id of this CreateEndpointDetails.

Methods

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

COMPUTE_TYPE_CPU = 'CPU'¶: A constant which can be used with the compute_type property of a CreateEndpointDetails. This constant has a value of “CPU”

COMPUTE_TYPE_GPU = 'GPU'¶: A constant which can be used with the compute_type property of a CreateEndpointDetails. This constant has a value of “GPU”

__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.
compute_type (str) – The value to assign to the compute_type property of this CreateEndpointDetails. Allowed values for this property are: “CPU”, “GPU”
alias (str) – The value to assign to the alias 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.
inference_units (int) – The value to assign to the inference_units 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.

alias¶

Gets the alias of this CreateEndpointDetails. Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.

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

compartment_id¶

[Required] Gets the compartment_id of this CreateEndpointDetails. The OCID compartment identifier for the endpoint

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

compute_type¶

Gets the compute_type of this CreateEndpointDetails. Compute infra type for endpoint.

Allowed values for this property are: “CPU”, “GPU”

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

defined_tags¶

Gets the defined_tags of this CreateEndpointDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this CreateEndpointDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this CreateEndpointDetails. A short description of the an endpoint.

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

display_name¶

Gets the display_name of this CreateEndpointDetails. A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.

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

freeform_tags¶

Gets the freeform_tags of this CreateEndpointDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this CreateEndpointDetails.
Return type:	dict(str, str)

inference_units¶

Gets the inference_units of this CreateEndpointDetails. Number of replicas required for this endpoint. This will be optional parameter. Default will be 1.

Returns:	The inference_units of this CreateEndpointDetails.
Return type:	int

model_id¶

[Required] Gets the model_id of this CreateEndpointDetails. The OCID of the model to associate with the endpoint.

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