OpenAI API 实战教程：如何稳定获取结构化 JSON 输出

pip install openai python-dotenv

# .env 文件

# 输入你在 uiuiapi.com 获取的 API 密钥或官方API秘钥
API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

# API 的基础 URL (例如 OpenAI 官方地址或uiuiAPI地址)
BASE_URL="https://uiuiapi地址/v1"

# 你希望使用的模型名称 (可选)
MODEL_NAME="gpt-4o"

import os
import json
from openai import OpenAI
from dotenv import load_dotenv

def main():
    """
    主函数，从 .env 文件加载配置并执行API调用。
    """
    # --- 1. 从 .env 文件加载环境变量 ---
    load_dotenv()

    # 使用 os.getenv() 安全地获取配置
    api_key = os.getenv("API_KEY")
    base_url = os.getenv("BASE_URL")
    model_name = os.getenv("MODEL_NAME", "gpt-4o") # 提供默认值

    # --- 检查配置是否存在 ---
    if not api_key or not base_url:
        print("错误：API_KEY 或 BASE_URL 未在 .env 文件中设置。")
        return

    print("--- 配置加载成功 ---")
    print(f"将要使用的模型: {model_name}")

    # ... 后续代码将在这里添加 ...

    # ... 接上文 ...

    # --- 2. 初始化API客户端 ---
    try:
        client = OpenAI(
            api_key=api_key,
            base_url=base_url,
        )
    except Exception as e:
        print(f"初始化OpenAI客户端时出错: {e}")
        return

    # --- 3. 准备API请求 ---
    source_text = "user email is test@example.com, and the user id is 12345."
    messages = [
        {"role": "system", "content": "You are a helpful assistant designed to output JSON."},
        {"role": "user", "content": f"From the text '{source_text}', extract the email and user ID. Please provide the output in a JSON format where the keys are exactly 'email' and 'user_id'."}
    ]

    # ... 接上文 ...

    # --- 4. 调用API并处理响应 ---
    print(f"\n--- 正在调用 API ... ---")
    try:
        response = client.chat.completions.create(
            model=model_name,
            # 这是启用 JSON 模式的关键！
            response_format={"type": "json_object"}, 
            messages=messages
        )
        json_content_string = response.choices[0].message.content
        
        print("API 调用成功，已收到响应。")
        print("\n--- API返回的原始JSON字符串 ---")
        print(json_content_string)
        
        # ... 后续解析代码 ...

    except Exception as e:
        print(f"\n调用API时发生错误: {e}")
        return
```response_format={"type": "json_object"}` 会指示模型**必须**返回一个语法正确的 JSON 对象。这比任何在提示文本中的要求都更加可靠和强制。

        # ... 接上文 ...
        
        # 解析并提取结果
        parsed_json = json.loads(json_content_string)
        print("\n--- 解析后的Python字典 ---")
        print(parsed_json)
        
        email = parsed_json.get('email')
        user_id = parsed_json.get('user_id')
        print("\n--- 提取结果 ---")
        print(f"Email: {email}" if email else "Email: 未找到")
        print(f"ID: {user_id}" if user_id else "ID: 未找到")

    except Exception as e:
        print(f"\n调用API时发生错误: {e}")
        return

if __name__ == "__main__":
    main()

python extract_info.py

--- 配置加载成功 ---
将要使用的模型: gpt-4o

--- 正在调用 API ... ---
API 调用成功，已收到响应。

--- API返回的原始JSON字符串 ---
{
  "email": "test@example.com",
  "user_id": "12345"
}

--- 解析后的Python字典 ---
{'email': 'test@example.com', 'user_id': '12345'}

--- 提取结果 ---
Email: test@example.com
ID: 12345