エンベディング

Prev Next

Classic/VPC環境で利用できます。

テキストを数字で表現するベクトル化を行います。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /v1/api-tools/embedding/{modelName}

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
Authorization Required 認証用 APIキー<例> Bearer nv-************
X-NCP-CLOVASTUDIO-REQUEST-ID Optional リクエスト ID
Content-Type Required リクエストデータの形式
  • application/json

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
modelName Enum Required エンベディング実行モデル
  • clir-emb-dolphin | clir-sts-dolphin
    • clir-emb-dolphin: すべてのドメインに適用可能な汎用性の高いモデル(デフォルト)
    • clir-sts-dolphin: 文の意味的なディテールを精密に測定するのに特化したモデル

リクエストボディ

ボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
text String Required エンベディング実行テキスト(トークン)
  • 1~500

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://clovastudio.stream.ntruss.com/testapp/v1/api-tools/embedding/{modelName}' \
--header 'Authorization: Bearer {API Key}' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: {Request ID}' \
--header 'Content-Type: application/json' \
--data '{
          "text": "今日の天気を教えて"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
embedding Array - エンベディング実行結果
  • 1,024個の Floatリストで構成
inputTokens Integer - エンベディング実行テキストのトークン数

レスポンス例

レスポンスのサンプルコードは次の通りです。

成功

呼び出しに成功した場合のレスポンスのサンプルコードは次の通りです。

{
    "status": {
      "code": "20000",
        "message": "OK"
      },
    "result": {
      "embedding": [ -0.3861295, -0.7903874, ... , 0.2994273, -0.7736456, -0.24933687 ]
      "inputTokens": 4
    }
  }

失敗

呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。