Skip to content

Add ensure_ascii parameter to json function #1547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add ensure_ascii parameter to json function #1547

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc1d433
add ensure_ascii to generate json
lm-cyber Apr 19, 2025
e2753d3
add docstring
lm-cyber Apr 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions outlines/generate/json.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ def json(
schema_object: Union[str, object, Callable],
sampler: Sampler = multinomial(),
whitespace_pattern: Optional[str] = None,
ensure_ascii: bool = True,
) -> SequenceGeneratorAdapter:
"""
Generate structured JSON data with a `Transformer` model based on a specified JSON Schema.
Expand All @@ -39,6 +40,9 @@ def json(
whitespace_pattern
Pattern to use for JSON syntactic whitespace (doesn't impact string literals)
Example: allow only a single space or newline with `whitespace_pattern=r"[\n ]?"`
ensure_ascii
If True, all non-ASCII characters in the output are escaped with \uXXXX sequences.
If False, non-ASCII characters are output as-is.

Returns
-------
Expand All @@ -47,12 +51,12 @@ def json(

"""
if isinstance(schema_object, type(BaseModel)):
schema = pyjson.dumps(schema_object.model_json_schema())
schema = pyjson.dumps(schema_object.model_json_schema(), ensure_ascii=ensure_ascii)
regex_str = build_regex_from_schema(schema, whitespace_pattern)
generator = regex(model, regex_str, sampler)
generator.format_sequence = lambda x: schema_object.parse_raw(x)
elif isinstance(schema_object, type(Enum)):
schema = pyjson.dumps(get_schema_from_enum(schema_object))
schema = pyjson.dumps(get_schema_from_enum(schema_object), ensure_ascii=ensure_ascii)
regex_str = build_regex_from_schema(schema, whitespace_pattern)
generator = regex(model, regex_str, sampler)
generator.format_sequence = lambda x: pyjson.loads(x)
Expand Down