Submit an embedding request

نقطهٔ پایانی /embeddings ورودی متنیِ شما را به یک بردار عددی (آرایه‌ای از اعداد اعشاری) تبدیل می‌کند؛ بردارهایی که فاصله و جهت نزدیک‌بودنشان بازنماییِ معناییِ متن است. خروجی مطابق فرمت list استاندارد OpenAI برمی‌گردد تا SDKها و کدهای موجود بدون تغییر کار کنند — فقط کافیست Base URL و کلید API آشا را تنظیم کنید.

ورودی می‌تواند یک رشته یا آرایه‌ای از رشته‌ها (برای پردازش دسته‌ای) باشد. جاسازی‌ها از استریم پشتیبانی نمی‌کنند.

Endpoint

https://app.asha-ai.ir/v1/embeddings

احراز هویت

با کلید API آشا از طریق هدر Authorization: Bearer <ASHA_API_KEY> احراز هویت کنید و هدر Content-Type: application/json را بفرستید.

پارامترهای بدنهٔ درخواست

به‌جز input و model که الزامی‌اند، بقیهٔ موارد اختیاری هستند:

مثال درخواست

curl https://app.asha-ai.ir/v1/embeddings 
  -H "Content-Type: application/json" 
  -H "Authorization: Bearer $ASHA_API_KEY" 
  -d '{
    "model": "openai/text-embedding-3-small",
    "input": "The quick brown fox jumps over the lazy dog",
    "dimensions": 1536
  }'

import requests

response = requests.post(
    'https://app.asha-ai.ir/v1/embeddings',
    headers={
        'Authorization': 'Bearer <ASHA_API_KEY>',
        'Content-Type': 'application/json',
    },
    json={
        'model': 'openai/text-embedding-3-small',
        'input': [
            'ماشین‌لرنینگ زیرمجموعه‌ای از هوش مصنوعی است',
            'یادگیری عمیق از شبکه‌های عصبی چندلایه استفاده می‌کند',
        ],
    },
)

data = response.json()
for item in data['data']:
    print(f"index={item['index']} dims={len(item['embedding'])}")

const response = await fetch('https://app.asha-ai.ir/v1/embeddings', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <ASHA_API_KEY>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    model: 'openai/text-embedding-3-small',
    input: 'The quick brown fox jumps over the lazy dog',
  }),
});

const data = await response.json();
console.log(data.data.map((d) => d.embedding.length));

پاسخ موفق

در صورت موفقیت، پاسخ با کد 200 برمی‌گردد:

{
  "object": "list",
  "id": "embd-1234567890",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [0.0023064255, -0.009327292, 0.015797347]
    }
  ],
  "model": "openai/text-embedding-3-small",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8,
    "cost": 0.0001
  }
}

فیلدهای پاسخ

خطاها

این نقطهٔ پایانی مجموعهٔ مشترکی از وضعیت‌های خطا را برمی‌گرداند:

جاسازی‌ها استریم نمی‌شوند؛ پاسخ همیشه یکجا با کد ۲۰۰ می‌آید.