Managed Inference and Agent APIの /v1/embeddings
この記事の英語版に更新があります。ご覧の翻訳には含まれていない変更点があるかもしれません。
最終更新日 2025年01月15日(水)
Table of Contents
Heroku Managed Inference and Agent アドオンは現在パイロット段階です。パイロットの一環として提供される製品は本番環境での使用を目的としたものではなく、ベータサービスとみなされています。また、https://www.salesforce.com/company/legal/agreements.jsp のベータサービス条件が適用されます。
/v1/embeddings エンドポイントは、提供された一連の入力テキストに対するベクトル埋め込み (基本的には数字のリスト) を生成します。これらの埋め込みは、検索、分類、クラスタリングなどのさまざまなユースケースに合わせて最適化されます。入力の処理方法をカスタマイズし、ニーズに合わせてさまざまな埋め込みタイプを選択できます。
リクエストボディパラメータ
必須パラメータ
| フィールド | 型 | 説明 | 例 |
|---|---|---|---|
| model | 文字列 | 使用する埋め込みモデルの ID | “cohere-embed-multilingual” |
| input | 配列 | モデルが埋め込む文字列の配列 (最大 96 個) (推奨される長さは文字列あたり 512 トークン未満) | [“文字列の例 1”, “文字列の例 2”] |
オプションパラメータ
| フィールド | 型 | 説明 | デフォルト | 例 |
|---|---|---|---|---|
| input_type | 列挙<文字列> | モデルに渡される入力の種類を指定します (入力に特別なトークンを付加)。 *次のいずれか: * search_document、search_query、classification、 clustering |
“search_document” | “search_query” |
| encoding_format | 列挙<文字列> | 出力のエンコード形式を決定します。 次のいずれか: raw または base64 |
“raw” | “base64” |
| embedding_type | 列挙<文字列> | 返される埋め込みの種類を指定します (float、int8、uint8、binary、ubinary) |
“float” | “int8” |
リクエストヘッダー
次の例では、モデルリソースに "EMBEDDING" のエイリアスがあると仮定します (これは、--as EMBEDDING フラグを使用してモデルリソースを作成したことを意味します)。
| ヘッダー | 型 | 説明 |
|---|---|---|
Authorization |
文字列 | AI アドオンの ‘EMBEDDING_KEY’ の値 (API ベアラートークン) |
推論の curl リクエストには、指定されたモデルの Heroku 推論キーを含む Authorization ヘッダーを含める必要があります。
たとえば、すべての /v1/embeddings curl リクエストはこちらのパターンに従います。
# If you're developing locally, run this to set your config vars as ENV variables.
eval $(heroku config -a $APP_NAME --shell | grep '^EMBEDDING_' | sed 's/^/export /' | tee >(cat >&2))
curl $EMBEDDING_URL/v1/embeddings \
-H "Authorization: Bearer $EMBEDDING_KEY" \
-d @- <<EOF
{
"model": "$EMBEDDING_MODEL_ID",
"input": "Hello, I am a long string (document) and I want to be turned into a searchable embedding vector! What fun!"
}
EOF