Zodiga JavaScriptis
Sellel lehel
Struktureeritud väljundid JavaScriptis
Kui arendad JavaScriptis või TypeScriptis, on Zod Pydantici vaste. See skeemi valideerimise teek lõimub sujuvalt Grok API-ga, et luua tüübitud struktureeritud väljundeid.
Paigaldamine
npm install zod openai
OpenAI JavaScripti SDK töötab otse Grok API-ga – sul tuleb lihtsalt suunata see õigele lõpp-punktile.
Kliendi seadistamine
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "your-xai-key",
baseURL: "https://api.x.ai/v1"
});
Skeemi määratlemine Zodiga
Zod kasutab skeemide määratlemiseks sujuvat API-d. Iga meetod vastab JSON-i tüübile:
import { z } from "zod";
const MovieReview = z.object({
title: z.string(),
rating: z.number(),
summary: z.string(),
recommend: z.boolean()
});
Tüüpide vastendamine
| Zod | JSON Schema | Pydantic (Python) |
|---|---|---|
z.string() | "type": "string" | str |
z.number() | "type": "number" | float |
z.boolean() | "type": "boolean" | bool |
z.array(z.string()) | stringide array | list[str] |
z.object({...}) | "type": "object" | BaseModel |
z.enum([...]) | enum | Literal[...] |
z.union([...]) | anyOf | Union tüübid |
z.nullable() | anyOf koos null-iga | str | None |
Täielik näide
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
Pesastatud skeemid
Nagu Pydantic, käsitleb Zod pesastamist loomulikult:
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())
});
Valikulised väljad koos nullable’iga
Välja valikuliseks tegemiseks (võimalus olla null) kasuta .nullable():
const Produit = z.object({
nom: z.string(),
prix: z.number(),
description: z.string().nullable(),
promotion: z.number().nullable()
});
Kliendipoolne valideerimine
Zodi üks eeliseid on võimalus valideerida andmeid kliendipoolselt, kasutades sama skeemi:
const rawData = JSON.parse(response.choices[0].message.content);
// Valideerimine Zodiga
const result = Analyse.safeParse(rawData);
if (result.success) {
console.log(result.data.titre);
} else {
console.error("Validation error:", result.error);
}
Praktikas õnnestub valideerimine alati, kuna API garanteerib skeemile vastavuse. Siiski on see täiendav kiht kasulik tootmiskeskkonna töökindluse tagamiseks.
Peamised punktid
- Zod on JavaScripti/TypeScripti vaste Pydanticule
- Süntaks on sujuv:
z.string(),z.number(),z.object({...}) .nullable()teeb välja valikuliseks (võib ollanull)- Edasta Zodi skeemid väärtusesse
response_format.json_schema.schema safeParse()võimaldab kaitsvat kliendipoolset valideerimist- OpenAI JavaScripti SDK töötab otse Grok API-ga