SemanticStore¶

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

Bases: object

A Semantic Store is a container resource of semantic records, with controllable enrichment refresh and synchronization policy.

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

Methods:

__init__(**kwargs)

Initializes a new SemanticStore object with values from keyword arguments.

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new SemanticStore 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 SemanticStore.
display_name (str) – The value to assign to the display_name property of this SemanticStore.
description (str) – The value to assign to the description property of this SemanticStore.
compartment_id (str) – The value to assign to the compartment_id property of this SemanticStore.
time_created (datetime) – The value to assign to the time_created property of this SemanticStore.
time_updated (datetime) – The value to assign to the time_updated property of this SemanticStore.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SemanticStore. 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 SemanticStore.
is_user_defined_semantics_enabled (bool) – The value to assign to the is_user_defined_semantics_enabled property of this SemanticStore.
data_source (oci.generative_ai.models.DataSourceDetails) – The value to assign to the data_source property of this SemanticStore.
model_selection (oci.generative_ai.models.SemanticStoreModelSelection) – The value to assign to the model_selection property of this SemanticStore.
refresh_schedule (oci.generative_ai.models.RefreshScheduleDetails) – The value to assign to the refresh_schedule property of this SemanticStore.
schemas (oci.generative_ai.models.SchemasDetails) – The value to assign to the schemas property of this SemanticStore.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SemanticStore.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SemanticStore.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SemanticStore.

property compartment_id¶

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

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

property data_source¶

[Required] Gets the data_source of this SemanticStore.

Returns: The data_source of this SemanticStore.
Return type: oci.generative_ai.models.DataSourceDetails

property defined_tags¶

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

property description¶

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

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

property display_name¶

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

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

property freeform_tags¶

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

property id¶

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

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

property is_user_defined_semantics_enabled¶

Gets the is_user_defined_semantics_enabled of this SemanticStore. Whether user-defined semantic inputs, such as annotations, comments, and synonyms, are enabled for semantic-store enrichment. When true, enrichment uses both metadata and user-defined semantics. When false, enrichment uses metadata only. If not specified when the semantic store is created, this value defaults to true.

Returns: The is_user_defined_semantics_enabled of this SemanticStore.
Return type: bool

property lifecycle_details¶

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

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

property lifecycle_state¶

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

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

property model_selection¶

Gets the model_selection of this SemanticStore.

Returns: The model_selection of this SemanticStore.
Return type: oci.generative_ai.models.SemanticStoreModelSelection

property refresh_schedule¶

Gets the refresh_schedule of this SemanticStore.

Returns: The refresh_schedule of this SemanticStore.
Return type: oci.generative_ai.models.RefreshScheduleDetails

property schemas¶

[Required] Gets the schemas of this SemanticStore.

Returns: The schemas of this SemanticStore.
Return type: oci.generative_ai.models.SchemasDetails

property system_tags¶

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

property time_created¶

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

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

property time_updated¶

[Required] Gets the time_updated of this SemanticStore. The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string.

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