SambaNova Cloudエンベッディング APIは、入力テキストのベクトル表現(エンベッディング)を生成し、意味的類似性分析、クラスタリング、検索最適化、検索拡張生成(RAG)などのタスクを容易にします。このAPIを使用することで、開発者はテキストデータを構造化された数値表現に変換することで、高度なAI機能をアプリケーションに統合できます。

エンドポイント

APIは入力テキストのエンベッディングベクトルを生成するエンドポイントを提供します。

リクエスト

POST https://api.sambanova.ai/v1/embeddings
Authorization: Bearer <your-api-key>

リクエストボディパラメータ

パラメータ説明必須
input文字列または文字列の配列エンベッドする入力テキスト。モデルのトークン制限を超えてはいけません。はい
model文字列エンベッディングの生成に使用するモデル(例:E5-Mistral-7B-Instruct)。はい
このAPIは、複数の入力形式をサポートしながらモデルの制約を適用し、効率的なエンベッディング生成を保証します。

リクエスト例

以下の例は、curlを使用してSambaNova Cloudエンベッディング APIにリクエストを送信する方法を示しています。

CURLリクエスト

CURL request
curl https://api.sambanova.ai/v1/embeddings \
  -H "Authorization: Bearer <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "The curious fox dashed through the golden field.",
    "model": "E5-Mistral-7B-Instruct"
  }'

レスポンス例

Example response
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [0.00333473, -0.0223934397434, ..., -0.013434322],
      "index": 0
    }
  ],
  "model": "E5-Mistral-7B-Instruct",
  "usage": {
    "prompt_tokens": 28,
    "total_tokens": 28
  }
}

レスポンスプロパティ

APIレスポンスは以下のプロパティで構成されています:
プロパティ説明
object文字列レスポンスの種類、常にlist
data配列エンベッディングオブジェクトのリスト。
model文字列エンベッディングの生成に使用されたモデルの名前。
usageオブジェクトリクエストのトークン使用統計、含まれるもの:prompt_tokens

エンベッディングオブジェクト

プロパティ説明
object文字列常にembedding
embedding配列浮動小数点数のリストとして表現されるエンベッディングベクトル。
index整数エンベッディングリスト内のエンベッディングのインデックス。

エラー処理

詳細はAPIエラーコードページをご覧ください。
エラータイプHTTPコード説明コード
無効なリクエストエラー400リクエストパラメータの問題(例:モデルが互換性がない、または入力が長すぎる)。invalid_request_error
認証エラー401提供されたAPIキーが無効です。invalid_authentication
レート制限超過429リクエストクォータを超過しました。insufficient_quota
リクエストタイムアウト408リクエストがタイムアウトしました。request_timeout

エラーレスポンスの例

Example error response
{
  "error": {
    "message": "Model 'model_name' does not support embeddings.",
    "type": "invalid_request_error",
    "param": "model",
    "code": "model_not_compatible"
  }
}