شروع سریع ادغام API شخصیت
این راهنمای شروع سریع، API شخصیت شما را در عرض چند دقیقه با SDKهای استاندارد OpenAI سازگار میکند. شما باید URL پایه را پیکربندی کنید، کلید API خود را تزریق کنید و اولین درخواست نامحدود خود را ارسال کنید.
نصب SDK
ابتدا کتابخانه کلاینت رسمی را برای زبان خود نصب کنید. این کار سازگاری با اندپوینت سازگار با OpenAI ارائهشده توسط ما را تضمین میکند. کتابخانه وظایف سریالسازی و منطق تلاش مجدد را برای شما انجام میدهد.
برای Python، از pip استفاده کنید. برای Node.js، از npm استفاده کنید. این مرحله چند ثانیه طول میکند و محیط را برای نمونههای کد بعدی آماده میسازد.
پیکربندی base_url خود
مشتری SDK خود را به نقطه پایانی ما پیکربندی کنید تا به مدل بدون سانسور دسترسی یابید. URL پایه HTTPS://api.apicharacter.com/v1 است. این URL، URL پیشفرض OpenAI را در پیکربندی شما جایگزین میکند.
بدون این تغییر، درخواستها شکست میخورند یا به سرویس اشتباه میرسند. شما فقط نیاز دارید این را یک بار هنگام مقداردهی اولیه نمونه مشتری (client instance) تنظیم کنید.
تنظیم کلید API خود
کلید خود را در متغیر محیطی یا پیکربندی کلاینت تزریق کنید. احراز هویت برای هر درخواست برای ردیابی مصرف اعتبار پیشپرداخت شما لازم است. کلید شما دسترسی به endpoint LLM بدون سانسور را فراهم میکند.
این مقدار را امن نگه دارید. این به عنوان تنها اعتبار حساب شما عمل میکند. برای دسترسی پایهای به شماره تلفن یا تأییدیه اضافی نیاز نیست.
اولین درخواست خود را انجام دهید
یک تکمیل چت ساده ارسال کنید تا اتصال را بررسی کنید. شناسه مدل "uncensored" است. این تأیید میکند که احراز هویت و URL پایه شما قبل از ساخت برنامهتان صحیح است.
مثال زیر را برای یک درخواست cURL استاندارد ببینید.
curl https://api.apicharacter.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "set my name to Alex"}]
}'
مدیریت پاسخهای پخش زنده
برای کاهش تأخیر در رابطهای چت خود، جریانیابی را فعال کنید. پارامتر stream را روی true در درخواست خود تنظیم کنید. SDK توکنها را همانطور که تولید میشوند بازگردانی میکند.
این برای تجربههای کاربری پاسخگو حیاتی است. شما قطعات جزئی را همانطور که از طریق رویدادهای ارسالشده توسط سرور (Server-Sent Events) دریافت میشوند، مدیریت میکنید.
stream = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Tell the story in second person."}],
stream=True,
)
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="", flush=True)
محدودیتها، خطاها و زمینه
محدودیتهای خود را درک کنید تا از وقفههای سرویس جلوگیری کنید. شما یک پنجره متن 100,000 توکن دریافت میکنید. حداکثر خروجی 16,000 توکن است مگر اینکه خلاف آن را مشخص کنید.
محدودیت نرخ ۳۰۰ درخواست در دقیقه است. خطای ۴۰۱ به معنای کلید نامعتبر است. خطای ۴۰۲ به معنای صفر بودن اعتبار است. خطای ۴۲۹ به معنای رسیدن به محدودیت نرخ است. این موارد را برای مقیاسپذیری در محیط تولید در نظر داشته باشید.
پایتون
from openai import OpenAI
client = OpenAI(base_url="https://api.apicharacter.com/v1", api_key="YOUR_KEY")
resp = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)Node.js
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.apicharacter.com/v1", apiKey: process.env.API_KEY });
const resp = await client.chat.completions.create({
model: "uncensored",
messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);سوالات متداول
چگونه کلید API شخصیت خود را دریافت کنم؟
با گوگل یا ایمیل روی داشبورد ثبتنام کنید. کلید API شما بلافاصله بدون تأیید شماره تلفن ظاهر میشود. میتوانید در صورت نیاز کلید جدیدی تولید کنید و کلید قبلی را جایگزین کنید.
آیا این یک API سازگار با openai است؟
بله، از فرمت استاندارد chat-completions پیروی میکند. تنها نیاز است URL پایه و کلید API را تغییر دهید. بیشتر SDKهای OpenAI با تغییرات پیکربندی جزئی به صورت پیشفرض کار میکنند.
اگر خطای 402 دریافت کنم چه اتفاقی میافتد؟
به این معناست که اعتبار از پیش پرداختشده شما تمام شده است. برای ادامه سرویس، از طریق ارز دیجیتال شارژ کنید. خطاها و رد کردنها اعتبار مصرف نمیکنند، بنابراین شما فقط بابت مصرف واقعی پرداخت میکنید.
کلید خود را فوری دریافت کنید
ثبتنام کنید، کلید را بردارید و URL پایه را بهروز کنید. همین است.