Compare two codebooks

Create a compact diff of two foundry_codebook objects, including both hashes, a unified diff of instructions, and field-level changes for schema properties and examples. Assign the result to inspect it without console output, or print it to display the diff.

Usage

codebook_diff(old, new)

# S3 method for class 'foundry_codebook_diff'
format(x, ...)

# S3 method for class 'foundry_codebook_diff'
print(x, ...)

Arguments

old, new

foundry_codebook objects to compare.

x

A foundry_codebook_diff object.

...

Unused.

Value

codebook_diff() returns a character vector of diff lines with class foundry_codebook_diff. format() returns the plain character vector. print() displays the lines and invisibly returns x.

Examples

old <- foundry_codebook(
  name = "support-sentiment",
  version = "1.0.0",
  instructions = "Label the sentiment of support tickets.",
  schema = foundry_schema(sentiment = type_enum(values = c("pos", "neg")))
)
#> Warning: `type_enum()` was deprecated in foundryR 1.0.0.
#> ℹ Please use `schema_enum()` instead.
#> ℹ foundryR's type_*() helpers mask ellmer's functions of the same names.
new <- foundry_codebook(
  name = "support-sentiment",
  version = "1.1.0",
  instructions = "Label the sentiment and urgency of support tickets.",
  schema = foundry_schema(
    sentiment = type_enum(values = c("pos", "neg")),
    urgent = type_boolean()
  )
)
#> Warning: `type_boolean()` was deprecated in foundryR 1.0.0.
#> ℹ Please use `schema_boolean()` instead.
#> ℹ foundryR's type_*() helpers mask ellmer's functions of the same names.
diff <- codebook_diff(old, new)
print(diff)
#> Codebook diff
#> old: support-sentiment 1.0.0 59e00aef3af73a552d791a1bc4bf73711075920d4ca79f9a1508f63e2cdc8555
#> new: support-sentiment 1.1.0 22828ea2e41623dd9ff47d3be91983121c540980d48860452079e1afa9c14323
#> 
#> Instructions:
#> --- old instructions
#> +++ new instructions
#> @@
#> -Label the sentiment of support tickets.
#> +Label the sentiment and urgency of support tickets.
#> 
#> Schema:
#>   sentiment: no change
#> + urgent: {"type":"boolean"}
#> 
#> Examples:
#>   (none)