エンベディング
- 印刷する
- PDF
エンベディング
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
テキストを数字で表現するベクトル化を行います。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /testapp/v1/api-tools/embedding/{modelName}/{appId} |
リクエストヘッダ
ヘッダの説明は次の通りです。
| ヘッダ | 必須の有無 | 説明 |
|---|---|---|
| X-NCP-CLOVASTUDIO-API-KEY | Y | テストアプリの作成時に発行された API KEY |
| X-NCP-APIGW-API-KEY | Y | テストアプリやサービスアプリの作成時に発行された API Gateway KEY |
| X-NCP-CLOVASTUDIO-REQUEST-ID | N | 各リクエストのリクエスト ID |
| Content-Type | Y | application/json |
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
| modelName | string(enum) | Y | エンベディング実行モデル: clir-emb-dolphin、clir-sts-dolphin |
| appId | string | Y | テストアプリ/サービスアプリの固有 ID |
リクエストモデル
モデルの説明は次の通りです。
| 名前 | clir-emb-dolphin | clir-sts-dolphin |
|---|---|---|
| 主な用途 | すべてのドメインに適用可能な汎用性の高いモデル｜文の意味的なディテールを精密に測定するのに特化したモデル |
リクエストボディ
ボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
| texts | string | Y | エンベディング実行テスト |
リクエスト構文
構文のサンプルコードは次の通りです。
curl --location 'https://clovastudio.apigw.ntruss.com/testapp/v1/api-tools/embedding/{modelName}/{appId}' \
--header 'X-NCP-CLOVASTUDIO-API-KEY: <X-NCP-CLOVASTUDIO-API-KEY>' \
--header 'X-NCP-APIGW-API-KEY: <X-NCP-APIGW-API-KEY>' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: <X-NCP-CLOVASTUDIO-REQUEST-ID>' \
--header 'Content-Type: application/json' \
--data '{
"text": "今日の天気を教えて"
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
ボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
| embedding | array[float] | Y | エンベディング実行結果(1024の float listで構成) |
| inputTokens | integer | Y | リクエストテキスト入力時に使用したトークン数 |
レスポンス構文
構文のサンプルコードは次の通りです。
成功
呼び出しに成功した場合の構文例は次の通りです。
{
"status": {
"code": "20000",
"message": "OK"
},
"result": {
"embedding": [ -0.3861295, -0.7903874, ... , 0.2994273, -0.7736456, -0.24933687 ]
"inputTokens": 4
}
}
失敗
呼び出しに失敗した場合の構文例は次の通りです。
この記事は役に立ちましたか?