Introduction
Large language models (LLMs) are great at generating content but the output format you get back can be a hit or miss sometimes.
For example, you ask for a JSON output in certain format and you might get free-form text or a JSON wrapped in markdown string or a proper JSON but with some required fields missing. If your application requires a strict format, this can be a real problem.
It might be possible to fix the output format with better prompts, or better output parsers that can detect formatting issues and fix them, or both but it’s extra work that you don’t need.
Vertex AI now has two new features, response_mime_type and response_schema
that helps to restrict the LLM outputs to a certain format.
Let’s take a look through an example main.py.
Without controlled generation
First, let’s ask a question to LLM without controlled generation:
model = GenerativeModel('gemini-1.5-flash-001')
prompt = "List a few popular cookie recipes"
response = model.generate_content(prompt)
Run it:
python main.py --project_id your-project-id without_controlled_generation1
You get a response in free text:
Prompt: List a few popular cookie recipes
Response: ## Popular Cookie Recipes:
**Classic and Simple:**
* **Chocolate Chip Cookies:** This timeless classic is a crowd-pleaser for a reason!
The perfect balance of sweet and chewy.
* **Sugar Cookies:**
...
You can try to format the response a little bit with more detailed prompt:
model = GenerativeModel('gemini-1.5-flash-001')
prompt = """
List a few popular cookie recipes using this JSON schema:
Recipe = {"recipe_name": str}
Return: list[Recipe]
"""
response = model.generate_content(prompt)
You get the following response:
Prompt:
List a few popular cookie recipes using this JSON schema:
Recipe = {"recipe_name": str}
Return: list[Recipe]
Response: ```json
[
{"recipe_name": "Chocolate Chip Cookies"},
{"recipe_name": "Oatmeal Raisin Cookies"},
{"recipe_name": "Snickerdoodles"},
{"recipe_name": "Sugar Cookies"},
{"recipe_name": "Peanut Butter Cookies"},
{"recipe_name": "Gingerbread Cookies"},
{"recipe_name": "Shortbread Cookies"}
]
The response is better but it’s in JSON markdown format and not quite JSON.
Generate with response mime type
One easy way of forcing JSON in response is to use the response_mime_type type
in the model:
model = GenerativeModel('gemini-1.5-flash-001',
generation_config=GenerationConfig(
response_mime_type="application/json"
))
prompt = """
List a few popular cookie recipes using this JSON schema:
Recipe = {"recipe_name": str}
Return: list[Recipe]
"""
response = model.generate_content(prompt)
Run it:
python main.py --project_id your-project-id with_response_mime_type
Now you should get proper JSON back:
Prompt:
List a few popular cookie recipes using this JSON schema:
Recipe = {"recipe_name": str}
Return: list[Recipe]
Response: [
{
"recipe_name": "Chocolate Chip Cookies"
},
{
"recipe_name": "Oatmeal Raisin Cookies"
},
{
"recipe_name": "Snickerdoodles"
},
{
"recipe_name": "Sugar Cookies"
},
{
"recipe_name": "Peanut Butter Cookies"
}
]
Generate with response schema
You can further enforce a schema with response_schema:
response_schema = {
"type": "array",
"items": {
"type": "object",
"properties": {
"recipe_name": {"type": "string"},
"calories": {"type": "integer"}
},
"required": ["recipe_name"]
},
}
model = GenerativeModel('gemini-1.5-pro-001',
generation_config=GenerationConfig(
response_mime_type="application/json",
response_schema=response_schema))
prompt = "List a few popular cookie recipes"
response = model.generate_content(prompt)
Note that the prompt does not talk about a format at all but the model knows how to structure the output.
Run it:
python main.py --project_id your-project-id with_response_schema1
The response respects the schema:
Prompt: List a few popular cookie recipes
Response: [
{
"recipe_name": "Chocolate Chip Cookies",
"calories": 150
},
{
"recipe_name": "Peanut Butter Cookies",
"calories": 160
},
{
"recipe_name": "Oatmeal Raisin Cookies",
"calories": 140
},
{
"recipe_name": "Sugar Cookies",
"calories": 130
}
]
Extract with response schema
You can also use response schema to extract information in a more structured way.
For example, you can extract social media comments from free-form text into a structured JSON format like this:
response_schema = {
"type": "array",
"items": {
"type": "object",
"properties": {
"dessert_name": { "type": "string"},
"rating" : { "type": "integer"},
"message": { "type": "string"}
},
"required": ["dessert_name", "rating", "message"]
},
}
model = GenerativeModel('gemini-1.5-pro-001',
generation_config=GenerationConfig(
response_mime_type="application/json",
response_schema=response_schema))
prompt = """
Extract reviews from our social media:
- "Absolutely loved it! Best ice cream I've ever had." Rating: 4
- "Quite good cheese cake, but a bit too sweet for my taste." Rating: 2
- "Did not like the tiramisu." Rating: 0
"""
response = model.generate_content(prompt)
Run it:
python main.py --project_id your-project-id with_response_schema2
You’ll get back the extracted information in JSON:
Prompt:
Extract reviews from our social media:
- "Absolutely loved it! Best ice cream I've ever had." Rating: 4
- "Quite good cheese cake, but a bit too sweet for my taste." Rating: 2
- "Did not like the tiramisu." Rating: 0
Response: [
{
"dessert_name": "ice cream",
"message": "Absolutely loved it! Best ice cream I've ever had",
"rating": 4
},
{
"dessert_name": "cheese cake",
"message": "Quite good cheese cake, but a bit too sweet for my taste",
"rating": 2
},
{
"dessert_name": "tiramisu",
"message": "Did not like the tiramisu",
"rating": 0
}
]
Conclusion
In this blog post, I explored how you can control the LLM output format in Vertex AI. It’s only limited to JSON right now but it provides an easy way of enforcing a certain JSON schema. If you want to learn more, here are some more resources: