Sentence Transformers: all-mpnet-base-v2
Sentence Transformersのall-mpnet-base-v2は、検索、クラスタリング、類似度比較のために、文や短い段落を768次元のベクトルへ変換します。公開された手順では平均プーリングとL2正規化を使い、既定では384ワードピースを超える入力を切り詰めます。
モデルについて
この説明はモデルの機能を紹介するものです。Ailootで利用できる入力、出力、オプションは、選択したメソッドごとに以下に記載されています。
all-mpnet-base-v2は、文や短い段落を768次元の密なベクトルで表現するSentence Transformersモデルです。MPNetのベースモデルを、10億組の文ペアからなるコレクションで対照学習により微調整しました。メーカーは、情報検索、クラスタリング、文の類似度比較を用途として挙げています。
文または短い段落をエンコードする
比較するテキストを準備し、主旨と、それを区別する詳細を残してください。社内文書のコレクションなら、短い節で機器の交換を依頼する方法や、保守報告に含める必要がある情報を説明できます。ベクトルとともに、文書のタイトルと出典の位置も参照できるようにしてください。
同じモデルで埋め込みに変換したクエリは、表現が異なっていても関連する節を検索できます。読者が実際に必要とする指示があるか、それらの節を点検してください。類似度のワークフローでは、特に一方にしかない例外や条件が含まれる場合、検索後に候補の文そのものを比較してください。
平均プーリングと正規化
参照用のエンコード例は、アテンションマスクを使ってパディングを平均から除外し、文脈を反映したトークン表現を平均します。その後、得られた文の埋め込みをL2正規化します。コレクションと、その後のクエリのベクトルを生成する際は、この両方の手順を維持してください。
各ベクトルには768個の成分があります。コサイン類似度で正規化した表現を比較でき、元のテキストは結果の裏付けとなる証拠を提供します。成分数が共通でも、このモデルがmulti-qa-mpnet-base-dot-v1と互換になるわけではありません。その別エディションは、内積による採点のためにCLSプーリングと非正規化ベクトルを指定しています。
既定の切り詰めと文章の準備
メーカーは、384ワードピースを超える入力を既定で切り詰めると述べています。関連する節は、そのトークナイザーの境界内に収めてください。長い手順では、意味のある節の境界で分割し、各工程が何に適用されるかを説明できるだけの周辺文脈を含めます。「5日以内に提出」のような断片には、期限の起点となる出来事や手続きが必要です。
学習時の手順では、シーケンスを128トークンに制限していました。これは、公開されているエンコード時の既定値384ワードピースとは別の設定です。長い段落やコレクション特有の語彙を評価する際は、代表的な資料を使用してください。より多くのテキストが入力に収まっても、すべての詳細が検索結果に等しく影響するとは限りません。
検索、グループ分け、比較
検索では、順位付きの候補から元の節を返せるよう、ベクトルと文書の対応関係を維持してください。RAGのワークフローでは、選択された節が回答作成段階の文脈になります。モデルが提供するのは数値表現です。出典付きの回答を生成したり、どの文書に権威があるかを決めたりするわけではありません。
クラスタリングでは、ラベルを付ける前に、提案された各グループ内のレコードを比較してください。一連の保守メモは、似た言葉を使いながら別の機器や故障条件について述べている場合があります。それらを区別する詳細をエンコード対象のテキストに含め、スコアだけに頼らず、返された資料で点検してください。
この正確なall-mpnet-base-v2チェックポイントは、固有の平均プーリング、正規化、既定の切り詰め設定を持つ英語の文埋め込みプロファイルです。それらの設定をインデックス化したコレクションとともに管理し、タスクに重要な原文の検索と比較を支援するものとしてベクトルを使用してください。
Ailoot Ultra · 埋め込み POST /v1/embeddings sentence-transformers/all-mpnet-base-v2
sentence-transformers/all-mpnet-base-v2
sentence-transformers/all-mpnet-base-v2はじめに
Sentence Transformersのall-mpnet-base-v2は、検索、クラスタリング、類似度比較のために、文や短い段落を768次元のベクトルへ変換します。公開された手順では平均プーリングとL2正規化を使い、既定では384ワードピースを超える入力を切り詰めます。
- 対応する入力
- テキスト · token_ids
- 結果
- embedding
Ailootで利用可能 · 入力とメソッド
Ailoot Ultra · 埋め込み POST /v1/embeddings
- 入力の種類
text,token_ids- 出力の種類
embedding- 出力形式
- json
| フィールド | 種類 | 要件 | 値と制限 | デフォルト |
|---|---|---|---|---|
フィールドmodel | 種類string | 要件必須 | 値と制限 sentence-transformers/all-mpnet-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": "sentence-transformers/all-mpnet-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='sentence-transformers/all-mpnet-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 sentence-transformers/all-mpnet-base-v2
メソッドパスのエイリアス
上記に表示されたメソッドパスを使用してください。
関連する呼び出し用ID
FAQ · Sentence Transformers: all-mpnet-base-v2
- 利用できる入力と結果は何ですか?
POST /v1/embeddings·sentence-transformers/all-mpnet-base-v2:text,token_ids→embedding- リクエストはどの項目を使用しますか?
POST /v1/embeddings·sentence-transformers/all-mpnet-base-v2:model,input,encoding_format,provider- どの制限が適用されますか?
POST /v1/embeddings·sentence-transformers/all-mpnet-base-v2:input.budget.maximum:512(UTF8 バイト);input.min_items:1