com.alecdorrington.annotatedtextformat.llm

Members list

Type members

Classlikes

final case class Anchored[+A](annotated: AnnotatedText[A], unplaced: List[Unplaced[A]])

QuotedAnnotation annotations anchored to a text: those found, as annotated, and those not, as unplaced, which may be sent back to the model that wrote them.

QuotedAnnotation annotations anchored to a text: those found, as annotated, and those not, as unplaced, which may be sent back to the model that wrote them.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Found(start: Int, end: Int, first: Int, last: Int, marked: Option[TextSpan])

Where a part of a quote was found, from start up to end; its first word beginning at first and its last ending at last; and the span that it marks, if it marks one, or else the whole of it.

Where a part of a quote was found, from start up to end; its first word beginning at first and its last ending at last; and the span that it marks, if it marks one, or else the whole of it.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Matching(anyCase: Boolean = ..., anySpacing: Boolean = ..., anyQuotes: Boolean = ..., wholeWords: Boolean = ...)

How loosely a part of a quote may match the text, as a model may quote it a little otherwise than it is written. QuotedAnnotation.anchor tries the text as it is quoted first, and only then as loosely as this allows.

How loosely a part of a quote may match the text, as a model may quote it a little otherwise than it is written. QuotedAnnotation.anchor tries the text as it is quoted first, and only then as loosely as this allows.

Letters are matched in either case by folding each character to lower case, alike on the JVM and in JavaScript; so "kiz" never matches "kız", and neither does "σ" match "ς", the final sigma. Text is not normalised, so a letter written with a combining accent does not match one written as a single character. Since a quote as written is sought before a looser match, an exact match further on is preferred to a nearer loose one: a straight don't quoted for a curly don’t is placed on a later straight one, if there is one.

Value parameters

anyCase

Whether letters match in either case.

anyQuotes

Whether each apostrophe matches any, and each double quotation mark any.

anySpacing

Whether words match with any whitespace between them, and punctuation with or without whitespace beside it, as a model may space a full stop.

wholeWords

Whether a part beginning or ending with a word matches only a whole word there, not part of one, as one joined to it by an apostrophe or hyphen, in scripts that end their words where their letters do.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Matching

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Matching.type
final case class QuotedAnnotation[+A](quote: String, value: A)

An annotation of a text as a large language model writes one: by quoting the passage it annotates, rather than by counting its characters, which models do badly. The annotations of a text are given in the order in which their passages begin.

An annotation of a text as a large language model writes one: by quoting the passage it annotates, rather than by counting its characters, which models do badly. The annotations of a text are given in the order in which their passages begin.

Value parameters

quote

The passage annotated, quoted exactly as the text writes it. Where other words split the passage, as they may a separable verb, its parts are quoted in order, joined by " … ", a space either side, as in "stehe … auf". A point between two characters, as where words belong, is quoted as a word or two around it with "‸" at the point, as in "is ‸late"; those words are not themselves annotated. Where the passage could be taken for the same words elsewhere, a word or two around it are quoted too, and the passage itself is marked with "⟦" and "⟧", as in "the ⟦cat⟧ sat". A part may hold a point or a marked passage, but not both.

Attributes

Note

Its value has no description here, so that a schema for it keeps its own type's. The marks in the quote's description are QuotedAnnotation.separator, QuotedAnnotation.caret, QuotedAnnotation.open and QuotedAnnotation.close.

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object Unplaced

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Unplaced.type
final case class Unplaced[+A](index: Int, quoted: QuotedAnnotation[A], reason: Reason)

The quoted annotation quoted, at index among those anchored, which could not be placed in the text, for reason.

The quoted annotation quoted, at index among those anchored, which could not be placed in the text, for reason.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all