Ръчен response_format
На тази страница
По-голям контрол с response_format
Ръчният метод чрез response_format Ви осигурява пълен контрол над анализирането (parsing). За разлика от parse(), който връща типизиран обект, този подход връща JSON низ, който анализирате сами – Pydantic моделът предоставя само схемата (model_json_schema()) и извършва валидация след това. Изберете този метод, когато имате нужда от гъвкавост или когато работите в среда без Pydantic.
Работен процес
При използване на response_format процесът протича на две стъпки:
- API връща JSON като низ в
response.choices[0].message.content - Вие анализирате този низ по избран от Вас метод
Пълен пример
from openai import OpenAI
from pydantic import BaseModel
client = OpenAI(
api_key="your-xai-key",
base_url="https://api.x.ai/v1"
)
class MovieReview(BaseModel):
title: str
rating: float
summary: str
recommend: bool
response = client.chat.completions.create(
model="grok-4.20-0309-reasoning",
messages=[{
"role": "user",
"content": "Review the movie Inception"
}],
response_format={
"type": "json_schema",
"json_schema": {
"name": "movie_review",
"schema": MovieReview.model_json_schema()
}
}
)
# Съдържанието е JSON низ
json_string = response.choices[0].message.content
print(type(json_string)) # <class 'str'>
print(json_string)
# {"title": "Inception", "rating": 9.2, "summary": "...", "recommend": true}
# Ръчно анализиране с Pydantic
parsed = MovieReview.model_validate_json(json_string)
print(parsed.title) # "Inception"
Разлики спрямо parse()
| Аспект | parse() | response_format |
|---|---|---|
| Връщана стойност | (Response, ParsedModel) | Само Response |
| Анализиране | Автоматично | Ръчно |
| Достъп до данни | parsed.field | json.loads() или model_validate_json() |
| Гъвкавост | Стандартна | Максимална |
| Обработка на грешки | Вградена | Ваша отговорност |
Анализиране без Pydantic
Не е задължително да използвате Pydantic, за да анализирате резултата. Стандартният модул json също работи:
import json
response = client.chat.completions.create(
model="grok-4.20-0309-reasoning",
messages=[{
"role": "user",
"content": "Analyze this text and extract entities"
}],
response_format={
"type": "json_schema",
"json_schema": {
"name": "entities",
"schema": {
"type": "object",
"properties": {
"people": {
"type": "array",
"items": { "type": "string" }
},
"places": {
"type": "array",
"items": { "type": "string" }
}
}
}
}
}
)
data = json.loads(response.choices[0].message.content)
print(data["people"]) # ["Marie Curie", "Pierre Curie"]
print(data["places"]) # ["Paris", "Warsaw"]
Кога да изберете response_format
response_format блести винаги, когато трябва да видите или инспектирате JSON, преди той да се превърне в обект. Най-честият случай е логирането: в производствена среда запазването на суровия JSON преди трансформация често е изискване за одит или отстраняване на грешки, а parse() не Ви предоставя тази точка на прихващане. Следва въпросът със схемата: ако Вашият договор за интерфейс е сурова JSON схема – споделена с други екипи, генерирана от инструмент, версионирана независимо от Python кода – нейното директно налагане е по-вярно от реконструирането ѝ като Pydantic модел. Накрая, не всеки проект оперира в екосистемата на Pydantic: ако валидацията Ви преминава през друг фреймуърк или през междинна стъпка на обработка, специфична за Вашия конвейер, response_format Ви предава JSON както си е и Ви оставя контрола над следващите действия.
Обработка на грешки
При ръчния метод трябва сами да обработвате грешки при анализирането:
import json
try:
data = json.loads(response.choices[0].message.content)
except json.JSONDecodeError as e:
print(f"Parsing error: {e}")
На практика тази грешка никога не би трябвало да възниква, тъй като API гарантира валиден JSON. Въпреки това, защитната обработка остава добра практика в производствена среда.
Ключови изводи
response_formatвръща JSON низ вresponse.choices[0].message.content- Анализирането е Ваша отговорност:
json.loads(),model_validate_json()или друг метод - Можете да използвате сурова JSON схема вместо Pydantic модел
- По-голяма гъвкавост от
parse(), но изисква повече код - Върнатият JSON е гарантирано валиден – грешки при анализирането не би трябвало да възникват