Zod ma' JavaScript
F'din il-paġna
Outputs strutturati f’JavaScript
Jekk qed tiżviluppa f’JavaScript jew TypeScript, Zod huwa l-ekwivalenti ta’ Pydantic. Din il-librerija ta’ validazzjoni tal-iskema tintegra bla xkiel mal-API ta’ Grok biex tipproduċi outputs strutturati ttajpjati.
Installazzjoni
npm install zod openai
L-SDK ta’ OpenAI għal JavaScript jaħdem direttament mal-API ta’ Grok—għandek biss tippuntah lejn l-endpoint korrett.
Konfigurazzjoni tal-klijent
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "your-xai-key",
baseURL: "https://api.x.ai/v1"
});
Definizzjoni ta’ skema b’Zod
Zod juża API fluwenti biex jiddefinixxi skemi. Kull metodu jikkorrispondi għal tip JSON:
import { z } from "zod";
const MovieReview = z.object({
title: z.string(),
rating: z.number(),
summary: z.string(),
recommend: z.boolean()
});
Mappatura tat-tipi
| Zod | Skema JSON | Pydantic (Python) |
|---|---|---|
z.string() | "type": "string" | str |
z.number() | "type": "number" | float |
z.boolean() | "type": "boolean" | bool |
z.array(z.string()) | array ta’ strings | list[str] |
z.object({...}) | "type": "object" | BaseModel |
z.enum([...]) | enum | Literal[...] |
z.union([...]) | anyOf | Tipi ta’ Union |
z.nullable() | anyOf b’null | str | None |
Eżempju sħiħ
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
Skemi mbejjna
Bħal Pydantic, Zod jimmanipula t-tbejjin b’mod naturali:
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())
});
Oqsma fakultattivi b’nullable
Biex tagħmel qasam fakultattiv (li jista’ jkun null), uża .nullable():
const Produit = z.object({
nom: z.string(),
prix: z.number(),
description: z.string().nullable(),
promotion: z.number().nullable()
});
Validazzjoni fuq in-naħa tal-klijent
Vantaġġ wieħed ta’ Zod huwa li tista’ tivvalida d-dejta fuq in-naħa tal-klijent bl-użu tal-istess skema:
const rawData = JSON.parse(response.choices[0].message.content);
// Validazzjoni b'Zod
const result = Analyse.safeParse(rawData);
if (result.success) {
console.log(result.data.titre);
} else {
console.error("Validation error:", result.error);
}
Fil-prattika, il-validazzjoni dejjem tirnexxi għax l-API tiggarantixxi l-konformità mal-iskema. Madankollu, dan is-saff addizzjonali huwa utli għar-robustezza fil-produzzjoni.
Punti Ewlenin
- Zod huwa l-ekwivalenti ta’ Pydantic għal JavaScript/TypeScript
- Is-sintassi hija fluwenti:
z.string(),z.number(),z.object({...}) .nullable()jagħmel qasam fakultattiv (jista’ jkunnull)- Għaddi skemi ta’ Zod f’
response_format.json_schema.schema safeParse()jippermetti validazzjoni difensiva fuq in-naħa tal-klijent- L-SDK ta’ OpenAI għal JavaScript jaħdem direttament mal-API ta’ Grok