SemanticStoreSummary¶

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

Bases: object

Summary information for a SemanticStore.

Methods:

__init__(**kwargs)

Initializes a new SemanticStoreSummary object with values from keyword arguments.

Attributes:

`compartment_id`	[Required] Gets the compartment_id of this SemanticStoreSummary.
`data_source`	[Required] Gets the data_source of this SemanticStoreSummary.
`defined_tags`	[Required] Gets the defined_tags of this SemanticStoreSummary.
`description`	Gets the description of this SemanticStoreSummary.
`display_name`	[Required] Gets the display_name of this SemanticStoreSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this SemanticStoreSummary.
`id`	[Required] Gets the id of this SemanticStoreSummary.
`is_user_defined_semantics_enabled`	Gets the is_user_defined_semantics_enabled of this SemanticStoreSummary.
`lifecycle_details`	Gets the lifecycle_details of this SemanticStoreSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this SemanticStoreSummary.
`model_selection`	Gets the model_selection of this SemanticStoreSummary.
`refresh_schedule`	Gets the refresh_schedule of this SemanticStoreSummary.
`schemas`	[Required] Gets the schemas of this SemanticStoreSummary.
`system_tags`	[Required] Gets the system_tags of this SemanticStoreSummary.
`time_created`	[Required] Gets the time_created of this SemanticStoreSummary.
`time_updated`	[Required] Gets the time_updated of this SemanticStoreSummary.

__init__(**kwargs)¶

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

property compartment_id¶

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

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

property data_source¶

[Required] Gets the data_source of this SemanticStoreSummary.

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

property defined_tags¶

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

property description¶

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

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

property display_name¶

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

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

property freeform_tags¶

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

property id¶

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

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

property is_user_defined_semantics_enabled¶

Gets the is_user_defined_semantics_enabled of this SemanticStoreSummary. 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 SemanticStoreSummary.
Return type: bool

property lifecycle_details¶

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

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

property lifecycle_state¶

[Required] Gets the lifecycle_state of this SemanticStoreSummary. The current state of the SemanticStore.

Allowed values are: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED

Returns: The lifecycle_state of this SemanticStoreSummary.
Return type: str

property model_selection¶

Gets the model_selection of this SemanticStoreSummary.

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

property refresh_schedule¶

Gets the refresh_schedule of this SemanticStoreSummary.

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

property schemas¶

[Required] Gets the schemas of this SemanticStoreSummary.

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

property system_tags¶

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

property time_created¶

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

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

property time_updated¶

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

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