エンドポイント
このAPIは、入力テキストに対してembeddingベクトルを生成するためのエンドポイントを提供します。リクエスト
Authorization
: Bearer <your-api-key>
リクエストボディのパラメータ
パラメータ | 型 | 説明 | 必須 |
---|---|---|---|
input | String または String配列 | 埋め込み対象の入力テキスト。モデルのトークン制限を超えないようにしてください。 | はい |
model | String | 使用するモデル名 (例: E5-Mistral-7B-Instruct )。 | はい |
リクエスト例
以下は、curl
コマンドを使用して SambaCloud Embeddings API にリクエストを送信する例です。
CURLリクエスト
CURL request
レスポンス例
Example response
レスポンスのプロパティ
レスポンスは以下のプロパティを含みます。プロパティ | 型 | 説明 |
---|---|---|
object | String | レスポンスの型。常にlist 。 |
data | Array | Embeddingオブジェクトのリスト。 |
model | String | 使用されたEmbeddingモデル名。 |
usage | Object | prompt_tokens などのトークン使用量情報。 |
Embeddingオブジェクト
プロパティ | 型 | 説明 |
---|---|---|
object | String | 常に "embedding" 。 |
embedding | Array | Embeddingベクトル (floatの配列)。 |
index | Integer | Embeddingリスト内における、対象のEmbeddingベクトルのindex。 |
エラーハンドリング
エラーの詳細については、 APIエラーコード をご参照ください。エラータイプ | HTTPコード | 説明 | エラーコード |
---|---|---|---|
Invalid request error (無効なリクエスト) | 400 | パラメータに問題が含まれます。 (例: モデル非対応、入力が長すぎる等) | invalid_request_error |
Authentication error (認証エラー) | 401 | APIキーが無効です。 | invalid_authentication |
Rate limit exceeded (レート制限超過) | 429 | リクエストがクォータ制限を超えました。 | insufficient_quota |
Request timeout (タイムアウト) | 408 | リクエストがタイムアウトしました。 | request_timeout |
エラーレスポンス例
Example error response