گفتگو و متن

ساخت بردار متن

متن را به بردار عددی تبدیل می‌کند، برای جست‌وجوی معنایی، خوشه‌بندی و بازیابی. قالب OpenAI، با حساب بر اساس توکن ورودی.

POST/v1/embeddings

یک متن یا چند متن را می‌دهید و برای هر کدام یک بردار می‌گیرید. بردارها به ترتیب input برمی‌گردند و index ترتیب را نشان می‌دهد. مدل باید از نوع بردار باشد، مثل openai/text-embedding-3-small؛ مدل گفتگو را اینجا بفرستید 400 model_kind_mismatch می‌گیرید.

input یک رشته، آرایه‌ای از رشته‌ها (تا 2048 مورد) یا آرایه‌ای از توکن‌های عددی است. هر رشته تا 200,000 نویسه و کل یک رشتهٔ تنها تا 2,000,000 نویسه.

هزینه بر اساس توکن ورودی است. اگر مدل شمار توکن را گزارش نکند، برآورد 1ai به‌کار می‌رود. پاسخ فقط prompt_tokens و total_tokens دارد و هزینهٔ اعتباری در هدر x-1ai-credits می‌آید.

dimensions و encoding_format به مدل می‌رسند. همهٔ مدل‌ها dimensions را نمی‌پذیرند؛ با encoding_format: "base64" بردار به‌جای آرایه، رشتهٔ base64 است. فیلدهای دیگر هم همان‌طور که هستند به مدل می‌رسند.

نمونه‌ها

curl https://1ai.ir/v1/embeddings \
  -H "Authorization: Bearer $ONEAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "openai/text-embedding-3-small",
  "input": "How do I reset my password?"
}'
200پاسخ
{
  "object": "list",
  "model": "openai/text-embedding-3-small",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        0.0123,
        -0.0456,
        0.0789,
        -0.0021,
        0.0334
      ]
    }
  ],
  "usage": {
    "prompt_tokens": 7,
    "total_tokens": 7
  }
}

هدرها

  • Authorizationstringالزامی

    Bearer sk-1ai-... با کلید API شما.

بدنه‌ی درخواست

  • modelstringالزامی

    نام کامل مدل بردار، مثل openai/text-embedding-3-small.

  • inputstring | arrayالزامی

    یک رشته، آرایه‌ای از 1 تا 2048 رشته، یا آرایه‌ای از توکن‌های عددی (و آرایه‌ای از آن‌ها).

  • dimensionsinteger

    تعداد ابعاد بردار، از 1 تا 10,000. فقط مدل‌هایی که ابعاد قابل‌تنظیم دارند می‌پذیرند.

  • encoding_formatstringپیش‌فرض: float

    قالب بردار در پاسخ.

    مقادیر مجاز:floatbase64

خطاها

  • invalid_request400

    بدنه نادرست است؛ مثلاً input خالی است یا از 2048 مورد بیشتر دارد.

  • model_kind_mismatch400

    مدل از نوع بردار نیست.

  • invalid_api_key401

    کلید نادرست، غیرفعال یا منقضی است.

  • insufficient_credits402

    اعتبار کافی نیست.

  • model_not_found404

    مدل وجود ندارد یا در دسترس شما نیست.

  • rate_limit_exceeded429

    به سقف نرخ رسیده‌اید.

صفحه‌های مرتبط