Zod med JavaScript
På denna sida
Strukturerade utdata i JavaScript
Om du utvecklar i JavaScript eller TypeScript är Zod motsvarigheten till Pydantic. Detta bibliotek för schemavalidering integreras sömlöst med Grok API för att producera typade strukturerade utdata.
Installation
npm install zod openai
OpenAI SDK för JavaScript fungerar direkt med Grok API – du behöver bara peka den mot rätt slutpunkt.
Klientkonfiguration
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "your-xai-key",
baseURL: "https://api.x.ai/v1"
});
Definiera ett schema med Zod
Zod använder ett flytande API för att definiera scheman. Varje metod motsvarar en JSON-typ:
import { z } from "zod";
const MovieReview = z.object({
title: z.string(),
rating: z.number(),
summary: z.string(),
recommend: z.boolean()
});
Typmappning
| 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 av strängar | list[str] |
z.object({...}) | "type": "object" | BaseModel |
z.enum([...]) | enum | Literal[...] |
z.union([...]) | anyOf | Unionstyper |
z.nullable() | anyOf med null | str | None |
Komplett exempel
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
Nästlade scheman
Precis som Pydantic hanterar Zod nästling naturligt:
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())
});
Valfria fält med nullable
För att göra ett fält valfritt (möjligt att vara null) använder du .nullable():
const Produit = z.object({
nom: z.string(),
prix: z.number(),
description: z.string().nullable(),
promotion: z.number().nullable()
});
Validering på klientsidan
En fördel med Zod är att du kan validera data på klientsidan med samma schema:
const rawData = JSON.parse(response.choices[0].message.content);
// Validering med Zod
const result = Analyse.safeParse(rawData);
if (result.success) {
console.log(result.data.titre);
} else {
console.error("Valideringsfel:", result.error);
}
I praktiken kommer valideringen alltid att lyckas eftersom API:t garanterar efterlevnad av schemat. Detta extra lager är dock användbart för robusthet i produktion.
Viktiga punkter
- Zod är JavaScript/TypeScript-motsvarigheten till Pydantic
- Syntaxen är flytande:
z.string(),z.number(),z.object({...}) .nullable()gör ett fält valfritt (kan varanull)- Skicka Zod-scheman i
response_format.json_schema.schema safeParse()möjliggör defensiv validering på klientsidan- OpenAI SDK för JavaScript fungerar direkt med Grok API