Show / Hide Table of Contents

Class KnowledgeBaseMetadataSummary

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

Inheritance
object
KnowledgeBaseMetadataSummary
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.GenerativeaiagentruntimeService.Models
Assembly: OCI.DotNetSDK.Generativeaiagentruntime.dll
Syntax
public class KnowledgeBaseMetadataSummary

Properties

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Name

Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

The name of the field

Remarks

Required

Operations

Declaration
[Required(ErrorMessage = "Operations is required.")]
[JsonProperty(PropertyName = "operations")]
public List<string> Operations { get; set; }
Property Value
Type Description
List<string>

List of supported operations for this field (e.g., "equals", "in", "contains")

Remarks

Required

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

Type

Declaration
[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
public string Type { get; set; }
Property Value
Type Description
string

The data type of the field (e.g., "array", "number", "string")

Remarks

Required

Values

Declaration
[Required(ErrorMessage = "Values is required.")]
[JsonProperty(PropertyName = "values")]
public List<KnowledgeBaseMetadataValue> Values { get; set; }
Property Value
Type Description
List<KnowledgeBaseMetadataValue>

List of metadata values available in the knowledge base along with the matching documents count.

Remarks

Required

In this article
Back to top