GenerativeAiProject¶

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

Bases: object

A GenerativeAiProject is a logical container that stores conversation, file and containers.

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

Methods

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new GenerativeAiProject 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 GenerativeAiProject.
display_name (str) – The value to assign to the display_name property of this GenerativeAiProject.
description (str) – The value to assign to the description property of this GenerativeAiProject.
compartment_id (str) – The value to assign to the compartment_id property of this GenerativeAiProject.
time_created (datetime) – The value to assign to the time_created property of this GenerativeAiProject.
time_updated (datetime) – The value to assign to the time_updated property of this GenerativeAiProject.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this GenerativeAiProject. 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 GenerativeAiProject.
conversation_config (oci.generative_ai.models.ConversationConfig) – The value to assign to the conversation_config property of this GenerativeAiProject.
long_term_memory_config (oci.generative_ai.models.LongTermMemoryConfig) – The value to assign to the long_term_memory_config property of this GenerativeAiProject.
short_term_memory_optimization_config (oci.generative_ai.models.ShortTermMemoryOptimizationConfig) – The value to assign to the short_term_memory_optimization_config property of this GenerativeAiProject.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this GenerativeAiProject.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this GenerativeAiProject.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this GenerativeAiProject.

compartment_id¶

[Required] Gets the compartment_id of this GenerativeAiProject. Owning compartment OCID for a GenerativeAiProject.

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

conversation_config¶

Gets the conversation_config of this GenerativeAiProject.

Returns:	The conversation_config of this GenerativeAiProject.
Return type:	oci.generative_ai.models.ConversationConfig

defined_tags¶

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

description¶

Gets the description of this GenerativeAiProject. An optional description of the GenerativeAiProject.

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

display_name¶

[Required] Gets the display_name of this GenerativeAiProject. A user-friendly name.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this GenerativeAiProject. An OCID that uniquely identifies a GenerativeAiProject.

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

lifecycle_details¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this GenerativeAiProject. The lifecycle state of a GenerativeAiProject.

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

long_term_memory_config¶

Gets the long_term_memory_config of this GenerativeAiProject.

Returns:	The long_term_memory_config of this GenerativeAiProject.
Return type:	oci.generative_ai.models.LongTermMemoryConfig

short_term_memory_optimization_config¶

Gets the short_term_memory_optimization_config of this GenerativeAiProject.

Returns:	The short_term_memory_optimization_config of this GenerativeAiProject.
Return type:	oci.generative_ai.models.ShortTermMemoryOptimizationConfig

system_tags¶

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

time_created¶

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

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

time_updated¶

Gets the time_updated of this GenerativeAiProject. The date and time that the generativeAiProject was updated in the format of an RFC3339 datetime string.

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