Zod JavaScript-del
Ezen az oldalon
Strukturált kimenetek JavaScriptben
Ha JavaScriptben vagy TypeScriptben fejlesztesz, a Zod a Pydantic megfelelője. Ez a sémavalidáló könyvtár zökkenőmentesen integrálódik a Grok API-val, hogy típusos strukturált kimeneteket hozz létre.
Telepítés
npm install zod openai
A JavaScripthez készült OpenAI SDK közvetlenül működik a Grok API-val – csupán a megfelelő végpontra kell irányítanod.
Kliens konfiguráció
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "your-xai-key",
baseURL: "https://api.x.ai/v1"
});
Séma definiálása Zoddal
A Zod egy fluens API-t használ a sémák definiálásához. Minden metódus egy JSON-típusnak felel meg:
import { z } from "zod";
const MovieReview = z.object({
title: z.string(),
rating: z.number(),
summary: z.string(),
recommend: z.boolean()
});
Típusleképezés
| Zod | JSON Séma | Pydantic (Python) |
|---|---|---|
z.string() | "type": "string" | str |
z.number() | "type": "number" | float |
z.boolean() | "type": "boolean" | bool |
z.array(z.string()) | stringek array-je | list[str] |
z.object({...}) | "type": "object" | BaseModel |
z.enum([...]) | enum | Literal[...] |
z.union([...]) | anyOf | Union típusok |
z.nullable() | anyOf null-lal | str | None |
Teljes példa
import OpenAI from "openai";
import { z } from "zod";
const client = new OpenAI({
apiKey: "your-xai-key",
baseURL: "https://api.x.ai/v1"
});
const Analyse = z.object({
titre: z.string(),
resume: z.string(),
sentiment: z.enum(["positif", "negatif", "neutre"]),
score: z.number(),
mots_cles: z.array(z.string()),
recommandation: z.boolean()
});
const response = await client.chat.completions.create({
model: "grok-4.20-0309-reasoning",
messages: [{
role: "user",
content: "Analyze the following text: Sales increased by 25% this quarter."
}],
response_format: {
type: "json_schema",
json_schema: {
name: "analyse",
schema: Analyse
}
}
});
const data = JSON.parse(response.choices[0].message.content);
console.log(data.sentiment); // "positive"
console.log(data.score); // 0.92
Beágyazott sémák
A Pydantichez hasonlóan a Zod természetesen kezeli a beágyazást is:
const Adresse = z.object({
rue: z.string(),
ville: z.string(),
code_postal: z.string(),
pays: z.string()
});
const Contact = z.object({
nom: z.string(),
email: z.string(),
telephone: z.string().nullable(),
adresse: Adresse,
tags: z.array(z.string())
});
Opcionális mezők a nullable segítségével
Ha egy mezőt opcionálissá (azaz null értéket felvevővé) szeretnél tenni, használd a .nullable() metódust:
const Produit = z.object({
nom: z.string(),
prix: z.number(),
description: z.string().nullable(),
promotion: z.number().nullable()
});
Kliensoldali validálás
A Zod egyik előnye, hogy ugyanazzal a sémával validálhatod az adatokat kliensoldalon is:
const rawData = JSON.parse(response.choices[0].message.content);
// Validálás Zoddal
const result = Analyse.safeParse(rawData);
if (result.success) {
console.log(result.data.titre);
} else {
console.error("Validation error:", result.error);
}
A gyakorlatban a validálás mindig sikerülni fog, mivel az API garantálja a séma megfelelőségét. Ez a további réteg azonban hasznos a robusztusság érdekében éles környezetben.
Főbb megállapítások
- A Zod a JavaScript/TypeScript megfelelője a Pydanticnek
- A szintaxis fluens:
z.string(),z.number(),z.object({...}) - A
.nullable()teszi opcionálissá a mezőt (felveheti anullértéket) - A Zod sémákat a
response_format.json_schema.schemamezőben kell átadni - A
safeParse()lehetővé teszi a védekező jellegű kliensoldali validálást - A JavaScripthez készült OpenAI SDK közvetlenül működik a Grok API-val