Endpoint¶
- class oci.ai_language.models.Endpoint(**kwargs)¶
Bases:
objectDescription of the endpoint.
Attributes:
A constant which can be used with the lifecycle_state property of a Endpoint.
A constant which can be used with the lifecycle_state property of a Endpoint.
A constant which can be used with the lifecycle_state property of a Endpoint.
A constant which can be used with the lifecycle_state property of a Endpoint.
A constant which can be used with the lifecycle_state property of a Endpoint.
A constant which can be used with the lifecycle_state property of a Endpoint.
Gets the alias of this Endpoint.
[Required] Gets the compartment_id of this Endpoint.
Gets the defined_tags of this Endpoint.
Gets the description of this Endpoint.
[Required] Gets the display_name of this Endpoint.
Gets the freeform_tags of this Endpoint.
[Required] Gets the id of this Endpoint.
Gets the inference_units of this Endpoint.
Gets the lifecycle_details of this Endpoint.
[Required] Gets the lifecycle_state of this Endpoint.
[Required] Gets the model_id of this Endpoint.
[Required] Gets the project_id of this Endpoint.
Gets the system_tags of this Endpoint.
[Required] Gets the time_created of this Endpoint.
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.
alias (str) – The value to assign to the alias property of this Endpoint.
display_name (str) – The value to assign to the display_name property of this Endpoint.
compartment_id (str) – The value to assign to the compartment_id property of this Endpoint.
project_id (str) – The value to assign to the project_id property of this Endpoint.
description (str) – The value to assign to the description 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: “DELETING”, “DELETED”, “FAILED”, “CREATING”, “ACTIVE”, “UPDATING”, ‘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.
inference_units (int) – The value to assign to the inference_units property of this Endpoint.
model_id (str) – The value to assign to the model_id 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 alias¶
Gets the alias of this Endpoint. Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
- Returns
The alias of this Endpoint.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this Endpoint. The OCID for the endpoint compartment.
- Returns
The compartment_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. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this Endpoint.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this Endpoint. A short description of the endpoint.
- Returns
The description of this Endpoint.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this Endpoint. 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 Endpoint.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this Endpoint. 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 Endpoint.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this Endpoint. Unique identifier endpoint OCID of an endpoint that is immutable on creation.
- Returns
The id of this Endpoint.
- Return type
str
- property inference_units¶
Gets the inference_units of this Endpoint. Number of replicas required for this endpoint.
- Returns
The inference_units of this Endpoint.
- Return type
int
- property lifecycle_details¶
Gets the lifecycle_details of this Endpoint. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
- Returns
The lifecycle_details of this Endpoint.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this Endpoint. The state of the endpoint.
Allowed values for this property are: “DELETING”, “DELETED”, “FAILED”, “CREATING”, “ACTIVE”, “UPDATING”, ‘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 to associate with the endpoint.
- Returns
The model_id of this Endpoint.
- Return type
str
- property project_id¶
[Required] Gets the project_id of this Endpoint. The OCID of the project to associate with the Endpoint.
- Returns
The project_id of this Endpoint.
- Return type
str
- property system_tags¶
Gets the system_tags of this Endpoint. Usage of system tag keys. These predefined keys are scoped to namespaces. 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 time the the endpoint was created. An RFC3339 formatted datetime string.
- Returns
The time_created of this Endpoint.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this Endpoint. The time the endpoint was updated. An RFC3339 formatted datetime string.
- Returns
The time_updated of this Endpoint.
- Return type
datetime