v1/embeddings/

v1/embeddings/

مدل‌های Embeddings توانایی اندازه‌گیری مرتبط بودن متون به یکدیگر را دارند. از Embeddings برای منظورهای مختلفی استفاده می‌شود, از جمله:

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

یک Embedding یک بردار از اعداد اعشاری است. فاصله بین دو متن بر اساس فاصله بین بردارهای آنها اندازه‌گیری می‌شود.

Embeddings API #

برای ساخت یک بردار Embeddings کافی است تا متن مورد نظر خود را همراه با مدلی که می‌خواهید برای ساخت Embeddings استفاده کنید به اندپوینت /v1/embeddings ارسال کنید.

نمونه‌ای از فواخوانی APIی Embeddings را در زیر مشاهده کنید:

1curl https://api.gilas.io/v1/embeddings \
2  -H "Content-Type: application/json" \
3  -H "Authorization: Bearer $GILAS_API_KEY" \
4  -d '{
5    "input": "Your text string goes here",
6    "model": "text-embedding-3-small"
7  }'

پاسخ مدل به درخواست شما یک بردار از اعداد اعشاری همراه با تعدادی متادیتا می‌باشد.

 1{
 2  "object": "list",
 3  "data": [
 4    {
 5      "object": "embedding",
 6      "index": 0,
 7      "embedding": [
 8        -0.006929283495992422,
 9        -0.005336422007530928,
10        ... (omitted for spacing)
11        -4.547132266452536e-05,
12        -0.024047505110502243
13      ],
14    }
15  ],
16  "model": "text-embedding-3-small",
17  "usage": {
18    "prompt_tokens": 5,
19    "total_tokens": 5
20  }
21}
توجه
در نظر داشته باشید که Gilas APIs از لحاظ فنی و نحوه کارکرد و قابلیت‌ها کاملا شبیه OpenAI APIs هستند. به همین منظور پیشنهاد میکنیم که برای آگاهی از نحوه‌ی کارکرد API ها به مستندات OpenAI API Reference و OpenAI Documentation ارجاع کنید.