Nous.KnowledgeBase.HealthReport (nous v0.15.8)

View Source

Result of a health check audit on the knowledge base.

Contains statistics, scores, and identified issues for maintenance.

Summary

Functions

Creates a new HealthReport from attributes.

Types

issue()

@type issue() :: %{
  type: issue_type(),
  entry_id: String.t() | nil,
  description: String.t(),
  severity: severity(),
  suggested_action: String.t()
}

issue_type()

@type issue_type() ::
  :stale | :inconsistent | :orphan | :gap | :low_confidence | :duplicate

severity()

@type severity() :: :low | :medium | :high

t()

@type t() :: %Nous.KnowledgeBase.HealthReport{
  coherence_score: float(),
  coverage_score: float(),
  created_at: DateTime.t(),
  freshness_score: float(),
  id: String.t(),
  issues: [issue()],
  kb_id: String.t() | nil,
  total_documents: non_neg_integer(),
  total_entries: non_neg_integer(),
  total_links: non_neg_integer()
}

Functions

new(attrs)

Creates a new HealthReport from attributes.