مرجع توسعه‌دهندگان

EFARS API

Embeddings

تبدیل متن به بردار برای مدل‌های دارای قابلیت بردارسازی.

راهنمای اتصال مشتریان
curl · Python · JavaScript

مسیر و مدل بردارساز

HTTP

POST https://efars.com/v1/embeddings
Authorization: Bearer YOUR_EFARS_API_KEY
Content-Type: application/json

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

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

پارامترها و درخواست

پارامترتوضیح
modelشناسه مدل بردارساز، الزامی.
inputمتن یا آرایه متن؛ قالب‌های دیگر وابسته به مدل هستند.
encoding_formatقالب خروجی، در صورت پشتیبانی مدل.
dimensionsتنها برای مدل‌های دارای پشتیبانی از ابعاد قابل انتخاب.

JSON

{
  "model": "EMBEDDING_MODEL_NAME",
  "input": "نمونه متن برای جست‌وجوی معنایی",
  "encoding_format": "float"
}

ساختار پاسخ بردار

JSON

{
  "object": "list",
  "model": "EMBEDDING_MODEL_NAME",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        0.01,
        -0.02,
        0.03
      ]
    }
  ],
  "usage": {
    "prompt_tokens": 0,
    "total_tokens": 0
  }
}

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

الگوی اتصال

الگوی HTTP سمت سرور در راهنمای Chat را با مسیر و بدنه Embeddings جایگزین کنید. پیش از پردازش data، کد HTTP و خطا را بررسی کنید.