Intfloat: E5-Base-v2
intfloat E5-Base-v2は、12層のエンコーダーで英語テキストを768次元の埋め込みに変換します。検索、言い換え比較、クラスタリング、テキスト特徴量の準備は、クエリ/文書の接頭辞と512トークンの窓によって定まります。
モデルについて
この説明はモデルの機能を紹介するものです。Ailootで利用できる入力、出力、オプションは、選択したメソッドごとに以下に記載されています。
E5-Base-v2 は intfloat の12層の英語埋め込みモデルで、768次元の表現を出力します。準備したテキストを1つの数値ベクトルに変換し、検索、意味比較、または別のタスクの特徴量として利用できます。Base v2 チェックポイントは、24層・1024次元の Large v2 エディションや、別途学習された多言語 E5 モデルとは異なります。
学習済みのロールプレフィックスを使う
E5 は入力の先頭にロールが付いていることを前提としています。パッセージ検索では、質問の先頭に「query:」を、答えを含み得る出典の先頭に「passage:」を付けます。意味類似度や言い換え検索のような対称的なタスクでは、開発元は両側に「query:」を付けることを推奨しています。ベクトルをクラスタリングや分類の特徴量として使う場合も、同じプレフィックスが推奨されています。
たとえば、フィードバックのコレクションには、同じ改善を求める言い回しの異なる要望が複数含まれることがあります。それらのレコードを推奨される対称的な準備方法でエンコードし、得られたベクトルを比較またはクラスタリングします。各表現に原文とレコード識別子を保持しておけば、クラスタを説明のない数値の集まりではなく、実際の顧客メッセージとして確認できます。
検索用のコレクションでは、質問と出典パッセージをそれぞれ対応するロールで準備します。有用なクエリの例は「query: Which setting changes the notification frequency?」(通知頻度を変更する設定はどれか)です。コーパスのパッセージには、説明とそれに関連する条件を残します。プレフィックスはモデルの学習時の準備方法の一部であり、省略すると性能が低下すると開発元は述べています。
表現をプーリングして比較する
公式の例では、アテンションマスクを考慮してパディングを除外したトークン表現の平均を計算し、得られたベクトルを正規化します。正規化した埋め込み同士の内積がコサイン類似度になります。出力される768個の値は1つのテキストを表すものであり、回答、クラスラベル、ペア単位のリランカースコアではありません。
クラスタリングのワークフローでは、別のステージがこれらのベクトルからグループを形成します。分類のワークフローでは、別のステージがそれらを入力特徴量として使います。この区別を保つと結果を解釈しやすくなります。埋め込みはレコードを表し、グループやラベルは後段のタスクが決定します。比較する表現には、1つのモデルと1つの準備規約を一貫して使います。
英語と512トークンの範囲で扱う
モデルカードによると、このエディションは英語のみに対応し、長いテキストは最大512トークンに切り詰められます。必要なロールプレフィックスを含め、その範囲内でまとまりのあるパッセージを準備します。長いレビュー、レポート、マニュアルは、末尾が失われる大きすぎる入力として埋め込むのではなく、意味のあるセクションごとに分割します。
見出しはそれが導入する文と一緒に保ち、ルールの意味を変える条件や例外も残します。フィードバックのような短いレコードは、収まる場合はメッセージ全体を保持します。ベクトルの横に出典の識別子とバージョンを保持しておけば、後でコレクションを更新する際に正しいレコードを置き換えられます。
タスクに応じて類似度を解釈する
開発元は、コサインスコアの絶対値よりも相対的な順位のほうが重要だと説明しています。絞り込みのしきい値はコレクション自身の事例で評価すべきであり、ベクトルの類似度は、ラベルの一致や正しい回答の確率として較正されたものではありません。ベクトルの使い方を決める際は、近傍のレコードや既知の不一致例を確認します。
有用な成果物は、英語の検索インデックス、意味比較のセット、または出典レコードと対になったテキストの数値特徴量です。この Base v2 プロファイルは独自の次元数、プーリング、ロールの準備方法を持っています。他の E5 エディションのベクトル形状や言語カバレッジが、互換性のある表現を保証するわけではありません。
Ailoot Ultra · 埋め込み POST /v1/embeddings intfloat/e5-base-v2
intfloat/e5-base-v2はじめに
intfloat E5-Base-v2は、12層のエンコーダーで英語テキストを768次元の埋め込みに変換します。検索、言い換え比較、クラスタリング、テキスト特徴量の準備は、クエリ/文書の接頭辞と512トークンの窓によって定まります。
- 対応する入力
- テキスト · token_ids
- 結果
- embedding
Ailootで利用可能 · 入力とメソッド
Ailoot Ultra · 埋め込み POST /v1/embeddings
- 入力の種類
text,token_ids- 出力の種類
embedding- 出力形式
- json
| フィールド | 種類 | 要件 | 値と制限 | デフォルト |
|---|---|---|---|---|
フィールドmodel | 種類string | 要件必須 | 値と制限 intfloat/e5-base-v2 | デフォルト— |
フィールドinput | 種類string|string[]|integer[]|integer[][] | 要件必須 | 値と制限 最小項目数: 1 条件: 空でなく、要素の型が統一されたバッチ。トークン ID は非負の整数です。 入力の許容量: 最大値: 512 · テキスト単位: UTF8 バイト · トークン単位: トークン配列の要素 | デフォルト— |
フィールドencoding_format | 種類string | 要件任意 | 値と制限 float | デフォルトfloat |
フィールドdimensions | 種類integer | 要件非対応 | 値と制限 最小値: 1 | デフォルト— |
フィールドuser | 種類json_value | 要件任意 | 値と制限 条件: ソースではこの JSON メタデータフィールドが許可されています。上流側での正確な意味はモデルによって異なります。 | デフォルト— |
フィールドsession_id | 種類json_value | 要件任意 | 値と制限 条件: ソースではこの JSON メタデータフィールドが許可されています。上流側での正確な意味はモデルによって異なります。 | デフォルト— |
フィールドtrace | 種類json_value | 要件任意 | 値と制限 条件: ソースではこの JSON メタデータフィールドが許可されています。上流側での正確な意味はモデルによって異なります。 | デフォルト— |
フィールドprovider | 種類object | 要件任意 | 値と制限 条件: provider.options は拒否されます | デフォルト— |
入力素材の組み合わせ
text_to_embedding
メソッドのパラメータとライフサイクル
| パラメータ | 仕様 |
|---|---|
パラメータcontent_type | 仕様application/json |
パラメータrequired | 仕様model, input |
パラメータinput_shapes | 仕様string, string[], nonnegative_integer_token_array, nonnegative_integer_token_array[] |
パラメータencoding_format | 仕様float |
パラメータdimensions_override | 仕様false |
パラメータmax_input_budget_units | 仕様512 |
パラメータmultimodal_objects | 仕様false |
パラメータmaterial_types | 仕様text, token_ids |
ライフサイクル: synchronous_json
各ベクトルのインデックスと次元数を保存してください。
モデル名がマルチモーダルであることを示していても、この正確なパスでは画像オブジェクトは受け付けられません。
料金
料金情報はリクエストの機能を追加しません。対応するパラメーターは選択したメソッドに記載されています。
- 高速モード
- 未指定 高速モードが選択されている場合
- Flex モード
- 未指定 flex モードが選択されている場合
- 最大推論量
- 未指定 推論量が最大で、調整に既定値(default)を使用する場合
Ailootの料金
設定別の価格
| 設定 | 料金表 | 料金 |
|---|---|---|
| 設定トークンの基本単価 | 料金表基本料金 | 料金 入力 · 入力トークン $0.00001 / 1K トークン 出力 · 出力トークン $0 / 1K トークン 入力 · キャッシュ読み取り — / 1K トークン 入力 · キャッシュ書き込み — / 1K トークン 入力 · キャッシュ書き込み、1時間 — / 1K トークン |
Ailootはリクエスト前に見積額を確保します。結果の取得後、実測使用量に基づいて最終料金を精算します。ストリーミング時の精算には最終の使用量記録を使用します。金額の確保と精算の仕組み →
リクエスト例
Ailoot Ultra · 埋め込み
set -eu
: "${AILOOT_API_KEY:?Set your Ailoot API key}"
python3 - <<'PY_REQUEST'
import json,os
from pathlib import Path
p=json.loads('{"model": "intfloat/e5-base-v2", "input": ["First document", "Second document"]}')
Path("request.json").write_text(json.dumps(p,ensure_ascii=False))
PY_REQUEST
curl --fail-with-body --silent --show-error https://api.ailoot.ai/v1/embeddings \
-H "Authorization: Bearer $AILOOT_API_KEY" -H 'Content-Type: application/json' \
--data-binary @request.json -D response-headers.txt -o result.json
python3 - <<'PY_RESULT'
import json
from pathlib import Path
r=json.loads(Path("result.json").read_text())
for x in r.get("data",[]): print(json.dumps({"index":x.get("index"),"embedding":x.get("embedding")}))
PY_RESULT
from openai import OpenAI
import os
client=OpenAI(base_url="https://api.ailoot.ai/v1",api_key=os.environ["AILOOT_API_KEY"],max_retries=0)
result=client.embeddings.create(model='intfloat/e5-base-v2',input=["First document","Second document"])
print(result)
for item in result.data:print(item.index,item.embedding)
結果を受け取って保存
Ailoot Ultra · 埋め込み
json
完了した結果をすべて保存
返された完全なレスポンス、ファイル、コンテンツ部分をすべて保存してください。
すべてのベクトルを、そのインデックスとともに保存してください。ベクトル数は入力数と一致し、次元数は統一されている必要があります。
元のレスポンスを確認する場合
埋め込みジョブ用のエンドポイントは新設されません。
レスポンスのフィールド
| フィールド | 種類 |
|---|---|
フィールドobject | 種類string |
フィールドmodel | 種類string |
フィールドdata[].index | 種類integer |
フィールドdata[].embedding | 種類finite float[] |
フィールドusage | 種類object |
エラーと次の手順
| レスポンス | 条件 | 次の手順 |
|---|---|---|
レスポンス400 · invalid_request_error | 条件必須フィールド、素材の表現形式、またはパラメーター値が不正です | 次の手順新しい生成リクエストを送る前に、指定されたフィールドを修正してください。 |
エイリアス
モデルのエイリアス
Ailoot Ultra intfloat/e5-base-v2
メソッドパスのエイリアス
上記に表示されたメソッドパスを使用してください。
関連する呼び出し用ID
FAQ · Intfloat: E5-Base-v2
- 利用できる入力と結果は何ですか?
POST /v1/embeddings·intfloat/e5-base-v2:text,token_ids→embedding- リクエストはどの項目を使用しますか?
POST /v1/embeddings·intfloat/e5-base-v2:model,input,encoding_format,provider- どの制限が適用されますか?
POST /v1/embeddings·intfloat/e5-base-v2:input.budget.maximum:512(UTF8 バイト);input.min_items:1