پرش به مطلب اصلی

APIهای متنی و داده

این بخش به APIهایی می‌پردازد که متن، پیام، خروجی ساختاریافته یا داده قابل جست‌وجو تولید می‌کنند. اگر می‌خواهید گدارAI را در محصول خودتان به کار بگیرید، این دسته معمولاً همان جایی است که تصمیم می‌گیرید «کدام نقطه پایانی برای این کار درست است؟».

قاعده شروع ساده است:

نیاز شماAPI پیشنهادیدلیل انتخاب
تولید پاسخ متنی، چت، ابزارها و خروجی ساختاریافتهChat Completionsرایج‌ترین مسیر سازگار با OpenAI برای بیشتر محصولات متنی است.
کار با قرارداد جدیدتر OpenAI برای تولید پاسخResponses APIوقتی تیم شما از ابتدا روی الگوی Responses طراحی می‌کند مناسب‌تر است.
سازگاری با قرارداد بومی AnthropicMessages APIبرای تیم‌هایی مهم است که به شکل پیام‌های Claude وابسته‌اند.
جست‌وجوی معنایی و RAGEmbeddingsمتن را به بردار عددی تبدیل می‌کند تا بتوانید شباهت معنایی را بسنجید.
بهترکردن ترتیب نتایج بازیابیRerankپس از جست‌وجوی اولیه، نتایج مرتبط‌تر را بالاتر می‌آورد.
بررسی ایمنی و سیاست محتوایی متنModerationپیش از نمایش یا پردازش متن، ریسک محتوایی را ارزیابی می‌کند.
پردازش انبوه و غیرتعاملیBatch APIبرای کارهای دسته‌ای و ناهم‌زمان طراحی می‌شود.

مسیر پیشنهادی مطالعه

اگر تازه با گدارAI شروع کرده‌اید، این ترتیب معمولاً کم‌ابهام‌ترین مسیر است:

  1. Chat Completions را بخوانید و یک درخواست ساده بفرستید.
  2. اگر خروجی باید JSON قابل اتکا باشد، خروجی ساختاریافته را اضافه کنید.
  3. اگر مدل باید داده بیرونی بگیرد یا کاری در سیستم شما انجام دهد، ابزارها را بخوانید.
  4. برای جست‌وجوی دانش، Embeddings و سپس Rerank را ببینید.
  5. برای کنترل ریسک محتوایی، Moderation را در مسیر ورودی یا خروجی خود قرار دهید.

سه اصل قبل از ارسال درخواست

  • شناسه مدل را حدس نزنید؛ آن را از مدل‌های مجاز فضای کاری یا مدل مجازی بردارید.
  • برای آزمایش انسانی از توکن دسترسی شخصی و برای سرویس‌های محیط عملیاتی از کلید دسترسی مجازی استفاده کنید.
  • پس از هر اتصال جدید، نتیجه را در گزارش رخدادها، سنجه‌ها و مصرف توکن بررسی کنید تا رفتار، هزینه و خطاها قابل پیگیری باشد.

پرسش‌های پرتکرار

از کدام API شروع کنم؟

برای بیشتر محصولات متنی، Chat Completions نقطه شروع مناسب‌تری است. بعد از پایدارشدن درخواست ساده، می‌توانید ابزارها، خروجی ساختاریافته، حافظه نهان یا استدلال را به همان مسیر اضافه کنید.

آیا همه APIهای این دسته در همه محیط‌ها فعال‌اند؟

خیر. فعال‌بودن هر API به تنظیمات فضای کاری، مدل‌های مجاز و ارائه‌دهنده‌های متصل بستگی دارد. در هر صفحه گفته می‌شود که چه چیزی باید در محیط شما فعال باشد.

آیا APIهای متنی و داده جای گاردریل‌ها را می‌گیرند؟

خیر. Moderation یک API مدل برای ارزیابی محتواست. گاردریل‌ها لایه اعمال سیاست در گدارAI هستند و می‌توانند قبل یا بعد از فراخوانی مدل اجرا شوند.