From 1c96c14a9e0bdf350ce1eb083328efec1fb8d36c Mon Sep 17 00:00:00 2001 From: Antonio Sarosi Date: Mon, 11 Nov 2024 17:49:47 +0000 Subject: [PATCH] Update `hoisted_class_prefix` docs with the new `"schema"` change (#1156) > [!IMPORTANT] > Update `output-format.mdx` to reflect change in default render message word from "schema" to "interface" for hoisted classes. > > - **Documentation Update**: > - In `output-format.mdx`, updated the description of `hoisted_class_prefix` to reflect the change in default render message word from "schema" to "interface". > - Updated example in `output-format.mdx` to use "interface" instead of "schema" in the rendered prompt. > > This description was created by [Ellipsis](https://www.ellipsis.dev?ref=BoundaryML%2Fbaml&utm_source=github&utm_medium=referral) for 0f56dcf0518690b967da079c67a381934de15bca. It will automatically update as commits are pushed. --- .../baml/prompt-syntax/output-format.mdx | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/fern/03-reference/baml/prompt-syntax/output-format.mdx b/fern/03-reference/baml/prompt-syntax/output-format.mdx index 5b6679004..26b70cfcb 100644 --- a/fern/03-reference/baml/prompt-syntax/output-format.mdx +++ b/fern/03-reference/baml/prompt-syntax/output-format.mdx @@ -127,7 +127,15 @@ You can always set it to ` | ` or something else for a specific model you use. Prefix of hoisted classes in the prompt. **Default: ``** Recursive classes are hoisted in the prompt so that any class field can -reference them using their name. +reference them using their name. This parameter controls the prefix used for +hoisted classes as well as the word used in the render message to refer to the +output type, which defaults to `"schema"`: + +``` +Answer in JSON using this schema: +``` + +See examples below. **Recursive BAML Prompt Example** @@ -176,7 +184,7 @@ interface Node { next: Node or null } -Answer in JSON using this schema: +Answer in JSON using this interface: { head: Node or null, len: int