Zodilla JavaScriptilla
Tällä sivulla
Jäsennetyt tulosteet JavaScriptissä
Jos kehität JavaScriptillä tai TypeScriptillä, Zod on Pydanticin vastine. Tämä skeeman validointikirjasto integroituu saumattomasti Grok API:hun tuottaen tyypitettyjä jäsennettyjä tulosteita.
Asennus
npm install zod openai
JavaScriptin OpenAI SDK toimii suoraan Grok API:n kanssa – sinun tarvitsee vain osoittaa se oikeaan päätepisteeseen.
Asiakasohjelman määritys
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "your-xai-key",
baseURL: "https://api.x.ai/v1"
});
Skeeman määrittäminen Zodilla
Zod käyttää fluentea API:a skeemojen määrittämiseen. Jokainen metodi vastaa JSON-tyyppiä:
import { z } from "zod";
const MovieReview = z.object({
title: z.string(),
rating: z.number(),
summary: z.string(),
recommend: z.boolean()
});
Tyyppien vastaavuus
| Zod | JSON Schema | Pydantic (Python) |
|---|---|---|
z.string() | "type": "string" | str |
z.number() | "type": "number" | float |
z.boolean() | "type": "boolean" | bool |
z.array(z.string()) | merkkijonojen array | list[str] |
z.object({...}) | "type": "object" | BaseModel |
z.enum([...]) | enum | Literal[...] |
z.union([...]) | anyOf | Union-tyypit |
z.nullable() | anyOf null-arvon kanssa | str | None |
Täydellinen esimerkki
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
Sisäkkäiset skeemat
Kuten Pydantic, Zod käsittelee sisäkkäisyyden luontevasti:
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())
});
Valinnaiset kentät nullable-metodilla
Jos haluat tehdä kentästä valinnaisen (se voi olla null), käytä metodia .nullable():
const Produit = z.object({
nom: z.string(),
prix: z.number(),
description: z.string().nullable(),
promotion: z.number().nullable()
});
Asiakaspuolen validointi
Yksi Zodin eduista on mahdollisuus validoida data asiakaspuolella käyttämällä samaa skeemaa:
const rawData = JSON.parse(response.choices[0].message.content);
// Validointi Zodilla
const result = Analyse.safeParse(rawData);
if (result.success) {
console.log(result.data.titre);
} else {
console.error("Validation error:", result.error);
}
Käytännössä validointi onnistuu aina, koska API takaa skeeman noudattamisen. Tämä lisäkerros on kuitenkin hyödyllinen tuotantoympäristön luotettavuuden kannalta.
Keskeiset asiat
- Zod on JavaScriptin/TypeScriptin vastine Pydanticille
- Syntaksi on fluentti:
z.string(),z.number(),z.object({...}) .nullable()tekee kentästä valinnaisen (voi ollanull)- Välitä Zod-skeemat kohtaan
response_format.json_schema.schema safeParse()mahdollistaa defensiivisen asiakaspuolen validoinnin- JavaScriptin OpenAI SDK toimii suoraan Grok API:n kanssa