CreateSemanticStoreDetails¶

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

Bases: object

The data to create a SemanticStore.

Methods:

__init__(**kwargs)

Initializes a new CreateSemanticStoreDetails object with values from keyword arguments.

Attributes:

`compartment_id`	[Required] Gets the compartment_id of this CreateSemanticStoreDetails.
`data_source`	[Required] Gets the data_source of this CreateSemanticStoreDetails.
`defined_tags`	Gets the defined_tags of this CreateSemanticStoreDetails.
`description`	Gets the description of this CreateSemanticStoreDetails.
`display_name`	[Required] Gets the display_name of this CreateSemanticStoreDetails.
`freeform_tags`	Gets the freeform_tags of this CreateSemanticStoreDetails.
`is_user_defined_semantics_enabled`	Gets the is_user_defined_semantics_enabled of this CreateSemanticStoreDetails.
`model_selection`	Gets the model_selection of this CreateSemanticStoreDetails.
`refresh_schedule`	Gets the refresh_schedule of this CreateSemanticStoreDetails.
`schemas`	[Required] Gets the schemas of this CreateSemanticStoreDetails.

__init__(**kwargs)¶

Initializes a new CreateSemanticStoreDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

description (str) – The value to assign to the description property of this CreateSemanticStoreDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateSemanticStoreDetails.
display_name (str) – The value to assign to the display_name property of this CreateSemanticStoreDetails.
is_user_defined_semantics_enabled (bool) – The value to assign to the is_user_defined_semantics_enabled property of this CreateSemanticStoreDetails.
model_selection (oci.generative_ai.models.SemanticStoreModelSelection) – The value to assign to the model_selection property of this CreateSemanticStoreDetails.
data_source (oci.generative_ai.models.CreateDataSourceDetails) – The value to assign to the data_source property of this CreateSemanticStoreDetails.
refresh_schedule (oci.generative_ai.models.RefreshScheduleDetails) – The value to assign to the refresh_schedule property of this CreateSemanticStoreDetails.
schemas (oci.generative_ai.models.CreateSchemasDetails) – The value to assign to the schemas property of this CreateSemanticStoreDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateSemanticStoreDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateSemanticStoreDetails.

property compartment_id¶

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

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

property data_source¶

[Required] Gets the data_source of this CreateSemanticStoreDetails.

Returns: The data_source of this CreateSemanticStoreDetails.
Return type: oci.generative_ai.models.CreateDataSourceDetails

property defined_tags¶

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

property description¶

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

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

property display_name¶

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

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

property freeform_tags¶

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

property is_user_defined_semantics_enabled¶

Gets the is_user_defined_semantics_enabled of this CreateSemanticStoreDetails. Whether to include user-defined semantic inputs, such as annotations, comments, and synonyms, during semantic-store enrichment. When true, enrichment uses both metadata and user-defined semantics. When false, enrichment uses metadata only. When omitted, this value defaults to true.

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

property model_selection¶

Gets the model_selection of this CreateSemanticStoreDetails.

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

property refresh_schedule¶

Gets the refresh_schedule of this CreateSemanticStoreDetails.

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

property schemas¶

[Required] Gets the schemas of this CreateSemanticStoreDetails.

Returns: The schemas of this CreateSemanticStoreDetails.
Return type: oci.generative_ai.models.CreateSchemasDetails