KnowledgeBase

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

Bases: object

A knowledge base is the base for all the data sources that an agent can use to retrieve information for its responses.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a KnowledgeBase.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a KnowledgeBase.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a KnowledgeBase.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a KnowledgeBase.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a KnowledgeBase.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a KnowledgeBase.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a KnowledgeBase.

compartment_id

[Required] Gets the compartment_id of this KnowledgeBase.

defined_tags

[Required] Gets the defined_tags of this KnowledgeBase.

description

Gets the description of this KnowledgeBase.

display_name

[Required] Gets the display_name of this KnowledgeBase.

freeform_tags

[Required] Gets the freeform_tags of this KnowledgeBase.

id

[Required] Gets the id of this KnowledgeBase.

index_config

[Required] Gets the index_config of this KnowledgeBase.

knowledge_base_statistics

Gets the knowledge_base_statistics of this KnowledgeBase.

lifecycle_details

Gets the lifecycle_details of this KnowledgeBase.

lifecycle_state

[Required] Gets the lifecycle_state of this KnowledgeBase.

system_tags

Gets the system_tags of this KnowledgeBase.

time_created

[Required] Gets the time_created of this KnowledgeBase.

time_updated

Gets the time_updated of this KnowledgeBase.

Methods:

__init__(**kwargs)

Initializes a new KnowledgeBase object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a KnowledgeBase. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a KnowledgeBase. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a KnowledgeBase. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a KnowledgeBase. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a KnowledgeBase. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a KnowledgeBase. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a KnowledgeBase. This constant has a value of “UPDATING”

__init__(**kwargs)

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

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

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

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

  • index_config (oci.generative_ai_agent.models.IndexConfig) – The value to assign to the index_config property of this KnowledgeBase.

  • knowledge_base_statistics (oci.generative_ai_agent.models.KnowledgeBaseStatistics) – The value to assign to the knowledge_base_statistics property of this KnowledgeBase.

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

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this KnowledgeBase. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “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 KnowledgeBase.

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

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

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

property compartment_id

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

Returns

The compartment_id of this KnowledgeBase.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

Gets the description of this KnowledgeBase. A description of the knowledge base.

Returns

The description of this KnowledgeBase.

Return type

str

property display_name

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

Returns

The display_name of this KnowledgeBase.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

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

Returns

The id of this KnowledgeBase.

Return type

str

property index_config

[Required] Gets the index_config of this KnowledgeBase.

Returns

The index_config of this KnowledgeBase.

Return type

oci.generative_ai_agent.models.IndexConfig

property knowledge_base_statistics

Gets the knowledge_base_statistics of this KnowledgeBase.

Returns

The knowledge_base_statistics of this KnowledgeBase.

Return type

oci.generative_ai_agent.models.KnowledgeBaseStatistics

property lifecycle_details

Gets the lifecycle_details of this KnowledgeBase. 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 KnowledgeBase.

Return type

str

property lifecycle_state

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

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “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 KnowledgeBase.

Return type

str

property system_tags

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

Return type

dict(str, dict(str, object))

property time_created

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

Return type

datetime

property time_updated

Gets the time_updated of this KnowledgeBase. 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 KnowledgeBase.

Return type

datetime