مرجع › مستندات Jev

SDK جاوااسکریپت / TypeScript

SDK جاوااسکریپت و TypeScript برای TypeSafe AI؛ نیازمند Node.js ۲۰ یا جدیدتر.

آخرین به‌روزرسانی: مدل: jev-1.13.0 منبع بازبینی‌شده در منبع انگلیسی

npm install @typesafe-ai/sdk

TYPESAFE_API_KEY را در محیط تنظیم کنید، سپس کلاینت را بسازید. تایپ پاسخ‌ها از روی پرسش‌ها استنتاج می‌شود. بسته شامل ESM، CommonJS و declarationهای TypeScript است.

import { choice, noul, score, TypeSafeClient } from "@typesafe-ai/sdk";

const client = new TypeSafeClient();

const response = await client.systemOne({
  state: { document: "I was charged twice. Please fix this ASAP." },
  questions: {
    category: choice("What is this ticket about?", {
      billing: null,
      technical: null,
      other: null,
    }),
    urgency: score("How urgent is this ticket?", ["Not urgent", "Soon", "Immediately"]),
    refund: noul("Does the customer ask for a refund?"),
  },
});

console.log(response.answers.category.choice); // تایپ: "billing" | "technical" | "other"

توابع کمکی

تابع	امضا	توضیح
`choice()`	choice(instructions, criteria)	پرسشی که بین گزینه‌های نام‌دار انتخاب می‌کند؛ criteria نگاشت برچسب به توصیف یا `null`.
`score()`	score(instructions, criteria)	پرسش Score با روبریک مرتب؛ دست‌کم دو توصیف با اندیس از صفر.
`noul()`	noul(instructions?, criteria?)	پرسش بله/خیر با توصیف اختیاری `true` و `false`.

پیکربندی کلاینت

apiKeystring

کلید API؛ در صورت نبود از TYPESAFE_API_KEY خوانده می‌شود.

baseURLstring

ریشه‌ی API؛ سپس TYPESAFE_BASE_URL و در نهایت https://api.typesafe.ai.

defaultModelstring

مدل پیش‌فرض؛ سپس TYPESAFE_DEFAULT_MODEL و در نهایت jev-latest.

dangerouslyAllowBrowserboolean

اجازه‌ی استفاده در مرورگر که کلید API را در معرض کاربران صفحه قرار می‌دهد. پیش‌فرض: false.

defaultHeaders / fetch / logger…

هدرهای اضافه، پیاده‌سازی سفارشی fetch برای تست یا transport، و لاگر.

کلید API را هرگز در کد سمت مرورگر قرار ندهید. فراخوانی‌ها را از سرور یا یک API میانی انجام دهید.