从AI平台检索JSON响应_通过 ai wcp 解析 json-优快云博客

介绍

在本文中，我们将探讨四个领先的AI平台——OpenAI、Groq、Gemini和Mistral如何处理JSON格式的响应。这些知识是从AI响应中获得干净、结构化数据的关键。

为什么这很重要？JSON是应用程序之间数据交换使用最广泛的格式之一。使用结构化输出，您可以确保AI响应始终遵循您指定的JSON架构，从而避免缺少键或无效值等问题。

轻松提取数据
制定精确查询
在UI中以最大程度的控制显示模型输出

无论您是经验丰富的开发人员还是刚开始AI集成，本指南都将帮助您掌握AI平台中的JSON，使您的应用程序更加可靠和高效。

JSON及其在AI API中的重要性

JSON或JavaScript Object Notation就像数据的通用语言。将其想象成一种以人类和计算机都可以轻松阅读的格式组织信息的方法。以下是它在AI中成为大问题的原因：

易于阅读：人类和机器都可以快速理解它。
灵活：它可以毫不费力地处理复杂的数据结构。
语言友好：大多数编程语言都可以开箱即用地使用JSON。
轻量级：它不会向数据添加不必要的批量。

{ 
   "name": "John Doe", 
   "age": 30, 
   "skills": ["Python", "AI", "JSON"] 
}

AI平台喜欢JSON

AI平台正在采用JSON，因为：

它使将AI集成到应用程序中变得更加顺畅。
可以准确指定所需的数据以及所需的数据方式。
它减少了AI和应用程序之间的错误和误解。

从LLM获取JSON的最佳实践

当您尝试从AI API获取JSON数据时，有一些技巧可以让您的生活变得更加轻松。通过遵循这些提示，您将立即成为从AI获取干净、有用的JSON的专家！

特定于平台的指南

OpenAI - JSON的结构化输出

OpenAI提供了两种强大的方法来生成结构化JSON响应：JSON模式和更高级的结构化输出功能。JSON模式可确保响应采用JSON格式，而结构化输出则通过保证遵守特定的JSON架构更进一步。这项新功能可在GPT-4及其变体等最新型号上使用，为开发人员提供了对AI生成内容结构的精确控制。通过使用结构化输出，您可以为所需的JSON响应定义确切的架构，从而显著减少对后处理和验证的需求。

如何使用结构化输出

定义架构：使用Pydantic（Python）或Zod（JavaScript）定义数据结构。

Python pydantic：

class BookReview(BaseModel):
    title: str
    author: str
    rating: int
    summary: str
    tags: List[str]

class Books(BaseModel):
    book_reviews: List[BookReview]

Javascript Zod：

const WeatherForecast = z.object({
 location: z.string(),
 date: z.string(),
 temperature: z.number(),
 conditions: z.string(),
 precipitation: z.number(),
})

安装所需的软件包：pydantic、openai
进行API调用：使用OpenAI SDK中的parse方法获取结构化响应。
处理响应：API返回与您的架构匹配的已解析数据。

Python示例：

from pydantic import BaseModel
from openai import OpenAI

client = OpenAI(
    api_key="OPENAI API key"
)

class CalendarEvent(BaseModel):
    name: str
    date: str
    participants: list[str]

completion = client.beta.chat.completions.parse(
    model="gpt-4o-2024-08-06",
    messages=[
        {"role": "system", "content": "Extract the event information."},
        {"role": "user", "content": "Alice and Bob are going to a science fair on Friday."},
    ],
    response_format=CalendarEvent,
)

event = completion.choices[0].message.parsed

print(event)
print(event.name)

# Output
# name='Science Fair' date='Friday' participants=['Alice', 'Bob']
# 'Science Fair'

Javascript 中的示例：

import OpenAI from "openai";
import { zodResponseFormat } from "openai/helpers/zod";
import { z } from "zod";

const openai = new OpenAI({
    apiKey: OPENAI_API_KEY
});

const CalendarEvent = z.object({
  name: z.string(),
  date: z.string(),
  participants: z.array(z.string()),
});

const completion = await openai.beta.chat.completions.parse({
  model: "gpt-4o-2024-08-06",
  messages: [
    { role: "system", content: "Extract the event information." },
    { role: "user", content: "Alice and Bob are going to a science fair on Friday." },
  ],
  response_format: zodResponseFormat(CalendarEvent, "event"),
});

const event = completion.choices[0].message.parsed;

console.log(event)

// Output
// {
//     name: 'Science Fair',
//     date: 'Friday',
//     participants: [ 'Alice', 'Bob' ]
// }

重要说明：

提供GPT-4o型号（gpt-4o-mini-2024-07-18及更高版本）
用于构建对用户的模型响应，而不是用于函数调用
架构中的所有字段都必须为必填字段

通过使用结构化输出，您可以确保您的AI响应始终采用您需要的格式，从而使您的应用程序更健壮且更易于开发。

Groq - JSON模式

Groq提供“JSON模式”，确保所有聊天完成都是有效的JSON。以下是有效使用它的方法：

主要特点：

保证有效的JSON：JSON模式下的所有响应都是有效的JSON。
精美打印的JSON：推荐使用以获得最佳效果。
模型性能：Mixtral > Gemma > Llama生成JSON。

如何使用JSON模式：

启用JSON模式：在聊天完成请求中设置“response_format”:{“type”： “json_object”}。
描述JSON结构：在系统提示符中包含所需JSON结构的描述。
处理错误：如果JSON生成失败，Groq将返回400错误，并带有代码json_validate_failed。

Python示例：

from typing import List, Optional
import json
from pydantic import BaseModel
from groq import Groq

groq = Groq(
   api_key=GROQ_API_KEY
)

class Ingredient(BaseModel):
   name: str
   quantity: str
   quantity_unit: Optional[str]

class Recipe(BaseModel):
   recipe_name: str
   ingredients: List[Ingredient]
   directions: List[str]

chat_completion = groq.chat.completions.create(
   messages=[
       {
           "role": "system",
           "content": "You are a recipe database that outputs recipes in JSON.\n The JSON object must use the schema: {json.dumps(Recipe.model_json_schema(), indent=2)}"
       },
       {
           "role": "user",
           "content": "Fetch a recipe for apple pie"
       }
   ],
   model="llama3-8b-8192",
   temperature=0,
   stream=False,
   response_format={"type": "json_object"}
)

recipe = Recipe.model_validate_json(chat_completion.choices[0].message.content)
print(recipe)

重要说明：

JSON模式不支持流式处理。
保持提示简洁以获得最佳结果。
使用Pydantic模型来定义和验证您的JSON架构。

通过使用JSON模式，您可以确保您的Groq API响应始终采用有效的JSON格式，从而更轻松地将AI生成的内容集成到您的应用程序中。

Gemini - JSON输出

Google的Gemini API提供了生成结构化JSON输出的强大功能，非常适合需要标准化数据格式的应用程序。

主要特点：

可配置输出：Gemini可以设置为生成JSON格式的响应。
架构定义：支持定义JSON架构以实现一致的输出结构。
灵活的实施：适用于Gemini 1.5 Flash和Gemini 1.5 Pro型号。

如何构建JSON的提示：

在Prompt（提示）中指定Format（格式）：在提示中清楚地描述所需的JSON结构。
使用Schema Definition：对于Gemini 1.5 Pro，请使用response_schema场进行更精确的控制。

Python代码示例：

import google.generativeai as genai
import os
import typing_extensions as typing

# Configure the API
genai.configure(api_key=API_KEY)

# Define the JSON schema
class Recipe(typing.TypedDict):
    recipe_name: str

# Initialize the model
model = genai.GenerativeModel('gemini-1.5-pro',
                              generation_config={
                                  "response_mime_type": "application/json",
                                  "response_schema": list[Recipe]
                              })

# Generate JSON content
prompt = "List 5 popular cookie recipes"
response = model.generate_content(prompt)
print(response.text)

最佳实践：

清除Schema Definition：始终明确定义预期的JSON结构。
使用适当的模型：根据您的需要在Gemini 1.5 Flash和Pro之间进行选择。
验证输出：始终验证收到的JSON以确保它满足您的要求。
错误处理：对JSON生成可能失败的情况实施强大的错误处理。
迭代优化：测试和优化提示以实现所需的输出一致性。

Mistral - JSON输出

Mistral提供了一种生成结构化JSON输出的简单方法，非常适合需要标准化数据格式的应用程序。

Mistral的JSON格式化方法：

JSON模式：在API请求中将response_format设置为{“type”:“json_object”}来启用。
明确说明：始终在提示中包含对JSON输出的明确请求。
型号兼容性：JSON模式可通过API用于所有Mistral模型。

优化JSON响应的提示：

具体性：在提示中明确定义所需的JSON结构。
保持简洁：请求简短的JSON对象，以防止输出过长。
验证输出：始终检查返回的JSON的正确性和结构。
迭代优化：测试和调整您的提示以获得一致的结果。

带有代码示例的分步指南：

import os
from mistralai import Mistral

# Set up API key and model
api_key = os.environ["MISTRAL_API_KEY"]
model = "mistral-large-latest"

# Initialize Mistral client
client = Mistral(api_key=api_key)

# Define the message requesting JSON output
messages = [
    {
        "role": "user",
        "content": "What is the best French meal? Return the name and ingredients in a short JSON object."
    }
]

# Request chat completion with JSON format
chat_response = client.chat.complete(
    model=model,
    messages=messages,
    response_format={"type": "json_object"}
)

# Print the JSON response
print(chat_response.choices[0].message.content)

预期输出：

{
  "name": "Coq au Vin",
  "ingredients": ["chicken", "red wine", "bacon", "mushrooms", "onions", "garlic", "chicken broth", "thyme", "bay leaf", "flour", "butter", "olive oil", "salt", "pepper"]
}

比较跨AI平台的JSON输出

在生成结构化JSON输出时，每个AI平台都有自己的方法。以下是OpenAI、Groq、Gemini和Mistral的比较：

JSON结构和格式

OpenAI：使用具有精确架构一致性的“结构化输出”功能。
Groq：提供保证有效JSON响应的“JSON模式”。
Gemini：使用架构定义选项提供灵活的JSON输出。
Mistral：为结构化输出实现简单的JSON模式。

优点和缺点

OpenAI	Groq	Gemini	Mistral
精确的架构控制类型安全和显式拒绝更复杂的设置	简单JSON模式激活精美打印的JSON支持仅限于特定型号（Mixtral > Gemma > Llama）	灵活的架构定义（类型提示或protobuf）适用于Flash 和Pro型号可能需要更迅速的工程设计才能保持一致	直接实施适用于所有Mistral型号需要在提示中发出显式JSON请求

OpenAI

Groq

Gemini

Mistral