SambaCloud Embeddings API は、入力されたテキストに対するベクトル表現 (embeddings; 埋め込み) を生成します。これにより、意味的類似性の分析、クラスタリング、検索最適化、検索拡張生成 (RAG) などのタスクを支援します。本APIを利用することで、テキストデータを構造化された数値表現に変換し、アプリケーションに高度なAI機能を統合できます。

エンドポイント

このAPIは、入力テキストに対してembeddingベクトルを生成するためのエンドポイントを提供します。

リクエスト

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

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

パラメータ説明必須
inputString または String配列埋め込み対象の入力テキスト。モデルのトークン制限を超えないようにしてください。はい
modelString使用するモデル名 (例: E5-Mistral-7B-Instruct)。はい
このAPIは、効率的なembedding生成を実現し、複数形式の入力に対応しつつ、モデルの制約を自動で適用します。

リクエスト例

以下は、curl コマンドを使用して SambaCloud Embeddings 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
  }
}

レスポンスのプロパティ

レスポンスは以下のプロパティを含みます。
プロパティ説明
objectStringレスポンスの型。常にlist
dataArrayEmbeddingオブジェクトのリスト。
modelString使用されたEmbeddingモデル名。
usageObjectprompt_tokens などのトークン使用量情報。

Embeddingオブジェクト

プロパティ説明
objectString常に "embedding"
embeddingArrayEmbeddingベクトル (floatの配列)。
indexIntegerEmbeddingリスト内における、対象のEmbeddingベクトルのindex。

エラーハンドリング

エラーの詳細については、 APIエラーコード をご参照ください。
エラータイプHTTPコード説明エラーコード
Invalid request error (無効なリクエスト)400パラメータに問題が含まれます。 (例: モデル非対応、入力が長すぎる等)invalid_request_error
Authentication error (認証エラー)401APIキーが無効です。invalid_authentication
Rate limit exceeded (レート制限超過)429リクエストがクォータ制限を超えました。insufficient_quota
Request timeout (タイムアウト)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"
  }
}