OpenAI 客户端

创建模型

from openai import OpenAI
from gimkit import from_openai

client = OpenAI()  # 从环境变量读取 OPENAI_API_KEY
model = from_openai(client, model_name="gpt-4o")

提示词建议

OpenAI 路径建议优先使用 use_gim_prompt=True。

直接在 f-string 里写自然语言模板并嵌入标签：

from gimkit import guide as g

query = f"""
Name: {g.person_name(name="name")}
Email: {g.e_mail(name="email")}
"""

result = model(query, output_type="json", use_gim_prompt=True)

如果你的 OpenAI 服务商不支持 JSON 约束，则退回 output_type=None：

result = model(query, output_type=None, use_gim_prompt=True)

输出类型

`output_type="json"`（推荐）

使用 JSON Schema 约束输出，并将 JSON 字段转换回标签结果。

result = model(query, output_type="json", use_gim_prompt=True)
print(result.tags["name"].content)

`output_type=None`（兜底）

当 OpenAI 服务商不支持 JSON 约束输出时使用。

result = model(query, output_type=None, use_gim_prompt=True)
print(result.tags["email"].content)

高级参数

include_grammar=True：在查询文本中注入语法定义。
backend：透传给 Outlines 生成器后端选择。
**inference_kwargs：透传到底层 OpenAI 推理参数。