[JSON] Add strict_properties kwarg to guidance.json to make JSON output terser by default
#1068
Conversation
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #1068 +/- ##
==========================================
- Coverage 65.54% 64.22% -1.32%
==========================================
Files 63 63
Lines 4844 4847 +3
==========================================
- Hits 3175 3113 -62
- Misses 1669 1734 +65 ☔ View full report in Codecov by Sentry. |
|
@Harsha-Nori I'm second-guessing the kwarg name here. We talked a bit yesterday about adding a |
|
Leaving the linked issue open, but closing this PR as the implementation will live in llguidance |
Adds a
strict_propertieskwarg toguidance.jsonwith a default value ofTrue.When
strict_propertiesisTrue, then any JSON schema that leavesadditionalPropertiesunset will be treated as if it were set toFalse. This means that the LLM will only generate properties that are explicitly requested by the schema. Explicitly settingadditionalPropertieswith any non-False schema will override this behavior.In the special case
guidance.jsonis called without a schema (None), the value ofstrict_propertieswill be ignored and "any valid json" can be generated.Note that this behavior isn't technically compliant with the official JSON Schema spec, and to enforce behavior in line with the spec, users should explicitly pass
strict_properties=Falsewhen callingguidance.json. TheTruebehavior will most likely be more in line with what users expect, however, and we adopt this as the default. Particularly when using thepydanticinterface, this means that users don't have to monkey around withConfigDicts.Closes #1050