Nota
A Nuvem do Ollama atualmente não suporta saídas estruturadas.
As saídas estruturadas permitem que você imponha um esquema JSON nas respostas do modelo para que você possa extrair dados estruturados de forma confiável, descrever imagens ou manter todas as respostas consistentes.
Gerando JSON estruturado
cURL
shell
curl -X POST http://localhost:11434/api/chat -H "Content-Type: application/json" -d '{
"model": "gpt-oss",
"messages": [{"role": "user", "content": "Tell me about Canada in one line"}],
"stream": false,
"format": "json"
}'Python
python
from ollama import chat
response = chat(
model='gpt-oss',
messages=[{'role': 'user', 'content': 'Tell me about Canada.'}],
format='json'
)
print(response.message.content)JavaScript
javascript
import ollama from 'ollama'
const response = await ollama.chat({
model: 'gpt-oss',
messages: [{ role: 'user', content: 'Tell me about Canada.' }],
format: 'json'
})
console.log(response.message.content)Gerando JSON estruturado com um esquema
Forneça um esquema JSON para o campo format.
Nota
É ideal também passar o esquema JSON como uma string no prompt para contextualizar a resposta do modelo.
cURL
shell
curl -X POST http://localhost:11434/api/chat -H "Content-Type: application/json" -d '{
"model": "gpt-oss",
"messages": [{"role": "user", "content": "Tell me about Canada."}],
"stream": false,
"format": {
"type": "object",
"properties": {
"name": {"type": "string"},
"capital": {"type": "string"},
"languages": {
"type": "array",
"items": {"type": "string"}
}
},
"required": ["name", "capital", "languages"]
}
}'Python
Use modelos Pydantic e passe model_json_schema() para format, depois valide a resposta:
python
from ollama import chat
from pydantic import BaseModel
class Country(BaseModel):
name: str
capital: str
languages: list[str]
response = chat(
model='gpt-oss',
messages=[{'role': 'user', 'content': 'Tell me about Canada.'}],
format=Country.model_json_schema(),
)
country = Country.model_validate_json(response.message.content)
print(country)JavaScript
Serialize um esquema Zod com z.toJSONSchema() e analise a resposta estruturada:
javascript
import ollama from 'ollama'
import * as z from 'zod'
const Country = z.object({
name: z.string(),
capital: z.string(),
languages: z.array(z.string()),
})
const response = await ollama.chat({
model: 'gpt-oss',
messages: [{ role: 'user', content: 'Tell me about Canada.' }],
format: z.toJSONSchema(Country),
})
const country = Country.parse(JSON.parse(response.message.content))
console.log(country)Exemplo: Extrair dados estruturados
Defina os objetos que você deseja que sejam retornados e deixe o modelo preencher os campos:
python
from ollama import chat
from pydantic import BaseModel
class Pet(BaseModel):
name: str
animal: str
age: int
color: str | None
favorite_toy: str | None
class PetList(BaseModel):
pets: list[Pet]
response = chat(
model='gpt-oss',
messages=[{'role': 'user', 'content': 'I have two cats named Luna and Loki...'}],
format=PetList.model_json_schema(),
)
pets = PetList.model_validate_json(response.message.content)
print(pets)Exemplo: Visão com saídas estruturadas
Modelos de visão aceitam o mesmo parâmetro format, permitindo descrições determinísticas de imagens:
python
from ollama import chat
from pydantic import BaseModel
from typing import Literal, Optional
class Object(BaseModel):
name: str
confidence: float
attributes: str
class ImageDescription(BaseModel):
summary: str
objects: list[Object]
scene: str
colors: list[str]
time_of_day: Literal['Morning', 'Afternoon', 'Evening', 'Night']
setting: Literal['Indoor', 'Outdoor', 'Unknown']
text_content: Optional[str] = None
response = chat(
model='gemma4',
messages=[{
'role': 'user',
'content': 'Describe this photo and list the objects you detect.',
'images': ['path/to/image.jpg'],
}],
format=ImageDescription.model_json_schema(),
options={'temperature': 0},
)
image_description = ImageDescription.model_validate_json(response.message.content)
print(image_description)Dicas para saídas estruturadas confiáveis
- Defina esquemas com Pydantic (Python) ou Zod (JavaScript) para que possam ser reutilizados para validação.
- Diminua a temperatura (por exemplo, defina-a como
0) para conclusões mais determinísticas. - As saídas estruturadas funcionam por meio da API compatível com OpenAI usando
response_format