Zod με JavaScript
Σε αυτήν τη σελίδα
Δομημένες έξοδοι σε JavaScript
Εάν αναπτύσσετε σε JavaScript ή TypeScript, το Zod αποτελεί το αντίστοιχο του Pydantic. Αυτή η βιβλιοθήκη επικύρωσης σχημάτων ενσωματώνεται απρόσκοπτα με το API του Grok για την παραγωγή δομημένων εξόδων με τύπους.
Εγκατάσταση
npm install zod openai
Το OpenAI SDK για JavaScript λειτουργεί απευθείας με το API του Grok· αρκεί να το κατευθύνετε στο σωστό endpoint.
Διαμόρφωση πελάτη
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "your-xai-key",
baseURL: "https://api.x.ai/v1"
});
Ορισμός σχήματος με Zod
Το Zod χρησιμοποιεί ένα fluent API για τον ορισμό σχημάτων. Κάθε μέθοδος αντιστοιχεί σε έναν τύπο JSON:
import { z } from "zod";
const MovieReview = z.object({
title: z.string(),
rating: z.number(),
summary: z.string(),
recommend: z.boolean()
});
Αντιστοίχιση τύπων
| Zod | JSON Schema | Pydantic (Python) |
|---|---|---|
z.string() | "type": "string" | str |
z.number() | "type": "number" | float |
z.boolean() | "type": "boolean" | bool |
z.array(z.string()) | array of strings | list[str] |
z.object({...}) | "type": "object" | BaseModel |
z.enum([...]) | enum | Literal[...] |
z.union([...]) | anyOf | Ένωση τύπων |
z.nullable() | anyOf με null | str | None |
Πλήρες παράδειγμα
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
Ένθετα σχήματα
Όπως το Pydantic, το Zod διαχειρίζεται φυσικά την ένθεση:
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())
});
Προαιρετικά πεδία με nullable
Για να κάνετε ένα πεδίο προαιρετικό (ικανό να λάβει την τιμή null), χρησιμοποιήστε το .nullable():
const Produit = z.object({
nom: z.string(),
prix: z.number(),
description: z.string().nullable(),
promotion: z.number().nullable()
});
Επικύρωση στην πλευρά του πελάτη
Ένα πλεονέκτημα του Zod είναι ότι μπορείτε να επικυρώσετε δεδομένα στην πλευρά του πελάτη χρησιμοποιώντας το ίδιο σχήμα:
const rawData = JSON.parse(response.choices[0].message.content);
// Επικύρωση με Zod
const result = Analyse.safeParse(rawData);
if (result.success) {
console.log(result.data.titre);
} else {
console.error("Validation error:", result.error);
}
Στην πράξη, η επικύρωση θα επιτυγχάνει πάντα, καθώς το API εγγυάται τη συμμόρφωση με το σχήμα. Ωστόσο, αυτό το επιπλέον επίπεδο είναι χρήσιμο για την ενίσχυση της αξιοπιστίας σε περιβάλλοντα παραγωγής.
Βασικά σημεία
- Το Zod είναι το αντίστοιχο του Pydantic για JavaScript/TypeScript
- Η σύνταξη είναι fluent:
z.string(),z.number(),z.object({...}) - Το
.nullable()καθιστά ένα πεδίο προαιρετικό (μπορεί να είναιnull) - Περάστε σχήματα Zod στο
response_format.json_schema.schema - Το
safeParse()επιτρέπει την αμυντική επικύρωση στην πλευρά του πελάτη - Το OpenAI SDK για JavaScript λειτουργεί απευθείας με το API του Grok