citations

package
v0.32.3 Latest Latest
Warning

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

Go to latest
Published: Nov 16, 2026 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package citations parses and structures source attributions in LLM responses that follow a retrieval pass. Two paths:

  • "tag" (default): the system prompt instructs the model to wrap cited spans with `<cite source="..." chunk="N"/>` markers. The plugin parses the tags, validates each against the current turn's retrieval context, strips tags from user-visible text, and emits a structured CitedResponse on `llm.response.cited`.

  • "anthropic_native": when the LLM provider already populates LLMResponse.Citations[], reuse those structured spans instead of parsing tags.

Either way the user-visible Text on the emitted CitedResponse is free of any in-band citation markup so IO renderers can footnote without post-processing.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New() engine.Plugin

Types

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

Plugin parses citation tags out of LLM responses and emits the structured counterpart event.

func (*Plugin) Capabilities

func (p *Plugin) Capabilities() []engine.Capability

func (*Plugin) ConfigSchema

func (p *Plugin) ConfigSchema() []byte

ConfigSchema implements engine.ConfigSchemaProvider.

func (*Plugin) Dependencies

func (p *Plugin) Dependencies() []string

func (*Plugin) Emissions

func (p *Plugin) Emissions() []string

func (*Plugin) ID

func (p *Plugin) ID() string

func (*Plugin) Init

func (p *Plugin) Init(ctx engine.PluginContext) error

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) Ready

func (p *Plugin) Ready() error

func (*Plugin) Requires

func (p *Plugin) Requires() []engine.Requirement

func (*Plugin) Shutdown

func (p *Plugin) Shutdown(_ context.Context) error

func (*Plugin) Subscriptions

func (p *Plugin) Subscriptions() []engine.EventSubscription

func (*Plugin) Version

func (p *Plugin) Version() string

Jump to

Keyboard shortcuts

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