KnowledgeBaseSummary

class oci.generative_ai_agent.models.KnowledgeBaseSummary(**kwargs)

Bases: object

Summary information about a knowledge base.

Methods:

__init__(**kwargs)

Initializes a new KnowledgeBaseSummary object with values from keyword arguments.

Attributes:

compartment_id

[Required] Gets the compartment_id of this KnowledgeBaseSummary.

defined_tags

[Required] Gets the defined_tags of this KnowledgeBaseSummary.

description

Gets the description of this KnowledgeBaseSummary.

display_name

[Required] Gets the display_name of this KnowledgeBaseSummary.

freeform_tags

[Required] Gets the freeform_tags of this KnowledgeBaseSummary.

id

[Required] Gets the id of this KnowledgeBaseSummary.

lifecycle_details

Gets the lifecycle_details of this KnowledgeBaseSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this KnowledgeBaseSummary.

system_tags

Gets the system_tags of this KnowledgeBaseSummary.

time_created

[Required] Gets the time_created of this KnowledgeBaseSummary.

time_updated

Gets the time_updated of this KnowledgeBaseSummary.

__init__(**kwargs)

Initializes a new KnowledgeBaseSummary 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 KnowledgeBaseSummary.

  • display_name (str) – The value to assign to the display_name property of this KnowledgeBaseSummary.

  • description (str) – The value to assign to the description property of this KnowledgeBaseSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this KnowledgeBaseSummary.

  • time_created (datetime) – The value to assign to the time_created property of this KnowledgeBaseSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this KnowledgeBaseSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this KnowledgeBaseSummary.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this KnowledgeBaseSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this KnowledgeBaseSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this KnowledgeBaseSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this KnowledgeBaseSummary.

property compartment_id

[Required] Gets the compartment_id of this KnowledgeBaseSummary. The OCID of the compartment.

Returns

The compartment_id of this KnowledgeBaseSummary.

Return type

str

property defined_tags

[Required] Gets the defined_tags of this KnowledgeBaseSummary. 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 KnowledgeBaseSummary.

Return type

dict(str, dict(str, object))

property description

Gets the description of this KnowledgeBaseSummary. A user-friendly description of the knowledge base.

Returns

The description of this KnowledgeBaseSummary.

Return type

str

property display_name

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

Returns

The display_name of this KnowledgeBaseSummary.

Return type

str

property freeform_tags

[Required] Gets the freeform_tags of this KnowledgeBaseSummary. 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 KnowledgeBaseSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this KnowledgeBaseSummary. The OCID of the knowledge base.

Returns

The id of this KnowledgeBaseSummary.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this KnowledgeBaseSummary. A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns

The lifecycle_details of this KnowledgeBaseSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this KnowledgeBaseSummary. The current state of the knowledge base.

Returns

The lifecycle_state of this KnowledgeBaseSummary.

Return type

str

property system_tags

Gets the system_tags of this KnowledgeBaseSummary. 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 KnowledgeBaseSummary.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this KnowledgeBaseSummary. The date and time the knowledge base was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns

The time_created of this KnowledgeBaseSummary.

Return type

datetime

property time_updated

Gets the time_updated of this KnowledgeBaseSummary. The date and time the knowledge base was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns

The time_updated of this KnowledgeBaseSummary.

Return type

datetime