content

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 18, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package content defines semantic types for content findings — problems with the accuracy and attribution of published content, such as a claim its cited source does not support, a quotation that cannot be found in its source or recording, or narration that does not say its script — and projects them into the domain-neutral findingspec.Finding.

Index

Constants

View Source
const (
	// RuleNoEvidence: the claim cites no source.
	RuleNoEvidence = "content.evidence.none"
	// RuleSourceUnknown: the claim cites a source that is not in the
	// source list.
	RuleSourceUnknown = "content.source.unknown"
	// RuleSourceUnreliable: the source is of a kind not accepted as
	// reliable, such as a forum, fan site, social media post or AI answer.
	RuleSourceUnreliable = "content.source.unreliable"
	// RuleSourceUnrated: the source's reliability could not be decided.
	RuleSourceUnrated = "content.source.unrated"
	// RuleSourceUnreachable: the source's text could not be retrieved, so
	// its quotations could not be checked.
	RuleSourceUnreachable = "content.source.unreachable"
	// RuleQuoteMissing: a supporting citation gives no quotation.
	RuleQuoteMissing = "content.quote.missing"
	// RuleQuoteNotFound: the quotation does not appear in the source's text.
	RuleQuoteNotFound = "content.quote.notFound"
	// RuleTranslationMissing: a quotation not in the reader's language has
	// no translation, or a translation has no language for its quotation.
	RuleTranslationMissing = "content.quote.translationMissing"
	// RuleFactsMissing: a date, figure or name in the claim does not
	// appear in any supporting quotation.
	RuleFactsMissing = "content.facts.missing"
	// RuleSingleSource: a claim stating dates, figures or quotations rests
	// on one source.
	RuleSingleSource = "content.claim.singleSource"
	// RuleNotAtomic: the claim states several facts, which are easier to
	// check and to disagree about separately.
	RuleNotAtomic = "content.claim.notAtomic"
	// RuleVerdict: a judge found the claim not supported as written, for
	// example contested, unsupported or contradicted.
	RuleVerdict = "content.claim.verdict"

	// RuleQuoteAudioDisputed: the engines disagree with each other on a
	// substantive word of the quotation, such as a number, a negation, a
	// name or a term, so the recording does not settle the wording.
	RuleQuoteAudioDisputed = "content.quote.audioDisputed"
	// RuleQuoteAudioMismatch: the engines agree with each other but not with
	// the quotation, so the quotation is not what was said. The finding
	// gives the wording the engines heard.
	RuleQuoteAudioMismatch = "content.quote.audioMismatch"
	// RuleQuoteAudioUnchecked: too few engines produced a transcript, or the
	// clip could not be cut, so the quotation was not checked.
	RuleQuoteAudioUnchecked = "content.quote.audioUnchecked"
)

Common rule IDs for problems with a claim and its sources. Scanners may define their own; these name the problems most claim checks share.

View Source
const (
	// TypeClaim marks findings about a claim or the sources it cites.
	TypeClaim = "claim"
	// TypeNarration marks findings about narration and its script.
	TypeNarration = "narration"
)

Finding types in the content domain.

View Source
const (
	// RuleNarrationMismatch: the recording does not say its script. Words
	// are dropped, added or misheard by every engine.
	RuleNarrationMismatch = "content.narration.mismatch"
)

Rules for narration: recorded or generated speech that should say a script, such as a course lesson's voice-over.

Variables

This section is empty.

Functions

func ClaimID

func ClaimID(f findingspec.Finding) string

ClaimID returns the claim a content finding is about, from its location, or "" when the finding is not about a claim. Findings with no type are treated as claim findings, as earlier versions wrote them.

func Segment added in v0.3.0

func Segment(f findingspec.Finding) string

Segment returns the narration segment a content finding is about, or "" when the finding is not about narration.

Types

type Issue

type Issue struct {
	ID          string `json:"id"`
	Rule        string `json:"rule"`
	Title       string `json:"title"`
	Description string `json:"description,omitempty"`
	// ClaimID identifies the claim the issue is about.
	ClaimID string `json:"claimId"`
	// Statement is the claim's text, shown as the finding's snippet.
	Statement string `json:"statement,omitempty"`
	// SourceRef identifies the cited source the issue is about, if any.
	SourceRef string `json:"sourceRef,omitempty"`
	// Document is the file that holds the claim, if known.
	Document string `json:"document,omitempty"`
	// Severity is the impact of the issue; defaults to Medium when unset.
	Severity   findingspec.Severity   `json:"severity,omitempty"`
	Confidence findingspec.Confidence `json:"confidence,omitempty"`

	Evidence    []findingspec.Evidence   `json:"evidence,omitempty"`
	Remediation *findingspec.Remediation `json:"remediation,omitempty"`
	Status      findingspec.Status       `json:"status,omitempty"`
	DetectedAt  *time.Time               `json:"detectedAt,omitempty"`
}

Issue is a content finding: a problem with one claim, or with one of the sources it cites.

func (Issue) ToFinding

func (i Issue) ToFinding() findingspec.Finding

ToFinding projects the issue into a domain-neutral findingspec.Finding in the content domain. The claim is the finding's location: Location.Component is the claim ID, Location.File the document holding it and Location.Snippet its statement. Severity defaults to Medium. The claim and source are also tags, "claim:<id>" and "source:<ref>", for filtering.

type NarrationIssue added in v0.3.0

type NarrationIssue struct {
	ID          string `json:"id"`
	Rule        string `json:"rule"`
	Title       string `json:"title"`
	Description string `json:"description,omitempty"`
	// Document is the file that holds the script, such as a slide deck.
	Document string `json:"document,omitempty"`
	// Segment identifies the part of the script, such as a slide's ID.
	Segment string `json:"segment"`
	// Expected is the script's wording for the segment.
	Expected string `json:"expected,omitempty"`
	// Heard is what the engines heard, when they agree.
	Heard string `json:"heard,omitempty"`
	// Recording is the audio file checked, if known.
	Recording string `json:"recording,omitempty"`
	// Severity is the impact of the issue; defaults to Medium when unset.
	Severity   findingspec.Severity   `json:"severity,omitempty"`
	Confidence findingspec.Confidence `json:"confidence,omitempty"`

	Evidence    []findingspec.Evidence   `json:"evidence,omitempty"`
	Remediation *findingspec.Remediation `json:"remediation,omitempty"`
	Status      findingspec.Status       `json:"status,omitempty"`
	DetectedAt  *time.Time               `json:"detectedAt,omitempty"`
}

NarrationIssue is a problem with narration: a recording, or one segment of it, that does not say its script.

func (NarrationIssue) ToFinding added in v0.3.0

func (i NarrationIssue) ToFinding() findingspec.Finding

ToFinding projects the narration issue into a findingspec.Finding in the content domain with type "narration". The segment is the location: Location.Component is the segment ID, Location.File the script's document and Location.Snippet the expected wording. Heard, when set, is added to the evidence as a "transcript" entry, after a copy of the issue's own evidence. Severity defaults to Medium. The segment and recording are also tags, "segment:<id>" and "recording:<file>".

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL