[doc] update baml example instruction on user roles #1316
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
georgeh0
reviewed
Nov 23, 2025
| **Why does this matter?** | ||
| - For Gemini and Anthropic models, BAML can sometimes infer or adjust the prompt structure, so extraction works either way. | ||
| - For **OpenAI models** (e.g., GPT-4/GPT-4o), if the PDF is **not** in the user role, the model doesn't see the file content — so extractions will fail or return empty fields. | ||
| - This can easily trip you up.If you're using BAML, **always double-check your prompt roles when adding file inputs**—especially for OpenAI backends. |
Member
There was a problem hiding this comment.
nit: up.If
missed a whitespace
| > This ensures the **PDF content is explicitly included as part of the user message**, rather than the system prompt. | ||
|
|
||
| **Why does this matter?** | ||
| - For Gemini and Anthropic models, BAML can sometimes infer or adjust the prompt structure, so extraction works either way. |
Member
There was a problem hiding this comment.
"BAML can sometimes infer or adjust the prompt structure"
Is it how it works? (I'm not sure, may missed something if this is specified somewhere)
I think it's just some subtle request format difference between OpenAI and others, so others tolerate that in the system prompt, while OpenAI doesn't.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.