RoutingProfile¶

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

Bases: object

A routing profile is a reusable set of policies that controls how Smart Router selects a target region and model for inference traffic. It can scope routing to allowed regions and allowed models.

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 RoutingProfile.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a RoutingProfile.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a RoutingProfile.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a RoutingProfile.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a RoutingProfile.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a RoutingProfile.
`compartment_id`	[Required] Gets the compartment_id of this RoutingProfile.
`defined_tags`	Gets the defined_tags of this RoutingProfile.
`description`	Gets the description of this RoutingProfile.
`display_name`	[Required] Gets the display_name of this RoutingProfile.
`freeform_tags`	Gets the freeform_tags of this RoutingProfile.
`id`	[Required] Gets the id of this RoutingProfile.
`lifecycle_details`	Gets the lifecycle_details of this RoutingProfile.
`lifecycle_state`	[Required] Gets the lifecycle_state of this RoutingProfile.
`model_routing_policy`	Gets the model_routing_policy of this RoutingProfile.
`previous_state`	Gets the previous_state of this RoutingProfile.
`region_routing_policy`	Gets the region_routing_policy of this RoutingProfile.
`system_tags`	Gets the system_tags of this RoutingProfile.
`time_created`	[Required] Gets the time_created of this RoutingProfile.
`time_updated`	Gets the time_updated of this RoutingProfile.

Methods

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new RoutingProfile 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 RoutingProfile.
display_name (str) – The value to assign to the display_name property of this RoutingProfile.
description (str) – The value to assign to the description property of this RoutingProfile.
compartment_id (str) – The value to assign to the compartment_id property of this RoutingProfile.
time_created (datetime) – The value to assign to the time_created property of this RoutingProfile.
time_updated (datetime) – The value to assign to the time_updated property of this RoutingProfile.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this RoutingProfile. 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 RoutingProfile.
region_routing_policy (oci.generative_ai.models.RegionRoutingPolicy) – The value to assign to the region_routing_policy property of this RoutingProfile.
model_routing_policy (oci.generative_ai.models.ModelRoutingPolicy) – The value to assign to the model_routing_policy property of this RoutingProfile.
previous_state (oci.generative_ai.models.PreviousRoutingProfileState) – The value to assign to the previous_state property of this RoutingProfile.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RoutingProfile.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RoutingProfile.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this RoutingProfile.

compartment_id¶

[Required] Gets the compartment_id of this RoutingProfile. The OCID of the compartment in which the routing profile lives.

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

defined_tags¶

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

description¶

Gets the description of this RoutingProfile. An optional description of the routing profile.

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

display_name¶

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

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

freeform_tags¶

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

id¶

[Required] Gets the id of this RoutingProfile. An OCID that uniquely identifies this routing profile resource.

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

lifecycle_details¶

Gets the lifecycle_details of this RoutingProfile. A message describing the current state of the routing profile in more detail that can provide actionable information.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this RoutingProfile. The current state of the routing profile.

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 RoutingProfile.
Return type:	str

model_routing_policy¶

Gets the model_routing_policy of this RoutingProfile.

Returns:	The model_routing_policy of this RoutingProfile.
Return type:	oci.generative_ai.models.ModelRoutingPolicy

previous_state¶

Gets the previous_state of this RoutingProfile.

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

region_routing_policy¶

Gets the region_routing_policy of this RoutingProfile.

Returns:	The region_routing_policy of this RoutingProfile.
Return type:	oci.generative_ai.models.RegionRoutingPolicy

system_tags¶

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

time_created¶

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

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

time_updated¶

Gets the time_updated of this RoutingProfile. The date and time that the routing profile was updated in the format of an RFC3339 datetime string.

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