Skip to content

Commit

Permalink
Update hoisted_class_prefix docs with the new "schema" change (#1156
Browse files Browse the repository at this point in the history
)

<!-- ELLIPSIS_HIDDEN -->



> [!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.
> 
> <sup>This description was created by </sup>[<img alt="Ellipsis"
src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=BoundaryML%2Fbaml&utm_source=github&utm_medium=referral)<sup>
for 0f56dcf. It will automatically
update as commits are pushed.</sup>

<!-- ELLIPSIS_HIDDEN -->
  • Loading branch information
antoniosarosi authored Nov 11, 2024
1 parent 873751b commit 1c96c14
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions fern/03-reference/baml/prompt-syntax/output-format.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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: `<none>`**

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**

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 1c96c14

Please sign in to comment.