KnowledgeBaseMetadataSummary¶

class oci.generative_ai_agent_runtime.models.KnowledgeBaseMetadataSummary(**kwargs)¶

Bases: object

Represents metadata about a field including its name, type, supported operations, and possible values.

Methods

__init__(**kwargs) Initializes a new KnowledgeBaseMetadataSummary object with values from keyword arguments.

Attributes

`defined_tags`	Gets the defined_tags of this KnowledgeBaseMetadataSummary.
`freeform_tags`	Gets the freeform_tags of this KnowledgeBaseMetadataSummary.
`name`	[Required] Gets the name of this KnowledgeBaseMetadataSummary.
`operations`	[Required] Gets the operations of this KnowledgeBaseMetadataSummary.
`system_tags`	Gets the system_tags of this KnowledgeBaseMetadataSummary.
`type`	[Required] Gets the type of this KnowledgeBaseMetadataSummary.
`values`	[Required] Gets the values of this KnowledgeBaseMetadataSummary.

__init__(**kwargs)¶

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

Parameters:

name (str) – The value to assign to the name property of this KnowledgeBaseMetadataSummary.
type (str) – The value to assign to the type property of this KnowledgeBaseMetadataSummary.
operations (list[str]) – The value to assign to the operations property of this KnowledgeBaseMetadataSummary.
values (list[oci.generative_ai_agent_runtime.models.KnowledgeBaseMetadataValue]) – The value to assign to the values property of this KnowledgeBaseMetadataSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this KnowledgeBaseMetadataSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this KnowledgeBaseMetadataSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this KnowledgeBaseMetadataSummary.

defined_tags¶

Gets the defined_tags of this KnowledgeBaseMetadataSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this KnowledgeBaseMetadataSummary.
Return type:	dict(str, dict(str, object))

freeform_tags¶

Gets the freeform_tags of this KnowledgeBaseMetadataSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this KnowledgeBaseMetadataSummary.
Return type:	dict(str, str)

name¶

[Required] Gets the name of this KnowledgeBaseMetadataSummary. The name of the field

Returns:	The name of this KnowledgeBaseMetadataSummary.
Return type:	str

operations¶

[Required] Gets the operations of this KnowledgeBaseMetadataSummary. List of supported operations for this field (e.g., “equals”, “in”, “contains”)

Returns:	The operations of this KnowledgeBaseMetadataSummary.
Return type:	list[str]

system_tags¶

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

type¶

[Required] Gets the type of this KnowledgeBaseMetadataSummary. The data type of the field (e.g., “array”, “number”, “string”)

Returns:	The type of this KnowledgeBaseMetadataSummary.
Return type:	str

values¶

[Required] Gets the values of this KnowledgeBaseMetadataSummary. List of metadata values available in the knowledge base along with the matching documents count.

Returns:	The values of this KnowledgeBaseMetadataSummary.
Return type:	list[oci.generative_ai_agent_runtime.models.KnowledgeBaseMetadataValue]