community: fix some features on Naver ChatModel & embedding model 2 (#29243)

## Description - Responding to `NCP API Key` changes. - To fix `ChatClovaX` `astream` function to raise `SSEError` when an error event occurs. - To add `token length` and `ai_filter` to ChatClovaX's `response_metadata`. - To update document for apply NCP API Key changes. cc. @efriis @vbarda
2025-09-07 14:03:26 +00:00 · 2025-01-21 01:01:03 +09:00
parent 5d64597490
commit 7a95ffc775
7 changed files with 240 additions and 97 deletions
--- a/docs/docs/integrations/chat/naver.ipynb
+++ b/docs/docs/integrations/chat/naver.ipynb
@@ -35,25 +35,24 @@
    "\n",
    "## Setup\n",
    "\n",
-    "Before using the chat model, you must go through the three steps below.\n",
+    "Before using the chat model, you must go through the four steps below.\n",
    "\n",
    "1. Creating [NAVER Cloud Platform](https://www.ncloud.com/) account \n",
    "2. Apply to use [CLOVA Studio](https://www.ncloud.com/product/aiService/clovaStudio)\n",
-    "3. Find API Keys after creating CLOVA Studio Test App or Service App (See [here](https://guide.ncloud-docs.com/docs/en/clovastudio-playground01#테스트앱생성).)\n",
+    "3. Create a CLOVA Studio Test App or Service App of a model to use (See [here](https://guide.ncloud-docs.com/docs/en/clovastudio-playground01#테스트앱생성).)\n",
+    "4. Issue a Test or Service API key (See [here](https://api.ncloud-docs.com/docs/ai-naver-clovastudio-summary#API%ED%82%A4).)\n",
    "\n",
    "### Credentials\n",
    "\n",
-    "CLOVA Studio requires 2 keys (`NCP_CLOVASTUDIO_API_KEY` and `NCP_APIGW_API_KEY`).\n",
-    "  - `NCP_CLOVASTUDIO_API_KEY` is issued per Test App or Service App\n",
-    "  - `NCP_APIGW_API_KEY` is issued per account, could be optional depending on the region you are using\n",
-    "\n",
-    "The two API Keys could be found by clicking `App Request Status` > `Service App, Test App List` > `‘Details’ button for each app` in [CLOVA Studio](https://clovastudio.ncloud.com/studio-application/service-app)\n",
+    "Set the `NCP_CLOVASTUDIO_API_KEY` environment variable with your API key.\n",
+    "  - Note that if you are using a legacy API Key (that doesn't start with `nv-*` prefix), you might need to get an additional API Key by clicking `App Request Status` > `Service App, Test App List` > `‘Details’ button for each app` in [CLOVA Studio](https://clovastudio.ncloud.com/studio-application/service-app) and set it as `NCP_APIGW_API_KEY`.\n",
    "\n",
    "You can add them to your environment variables as below:\n",
    "\n",
    "``` bash\n",
    "export NCP_CLOVASTUDIO_API_KEY=\"your-api-key-here\"\n",
-    "export NCP_APIGW_API_KEY=\"your-api-key-here\"\n",
+    "# Uncomment below to use a legacy API key\n",
+    "# export NCP_APIGW_API_KEY=\"your-api-key-here\"\n",
    "```"
   ]
  },
@@ -71,10 +70,11 @@
    "    os.environ[\"NCP_CLOVASTUDIO_API_KEY\"] = getpass.getpass(\n",
    "        \"Enter your NCP CLOVA Studio API Key: \"\n",
    "    )\n",
-    "if not os.getenv(\"NCP_APIGW_API_KEY\"):\n",
-    "    os.environ[\"NCP_APIGW_API_KEY\"] = getpass.getpass(\n",
-    "        \"Enter your NCP API Gateway API key: \"\n",
-    "    )"
+    "# Uncomment below to use a legacy API key\n",
+    "# if not os.getenv(\"NCP_APIGW_API_KEY\"):\n",
+    "#     os.environ[\"NCP_APIGW_API_KEY\"] = getpass.getpass(\n",
+    "#         \"Enter your NCP API Gateway API key: \"\n",
+    "#     )"
   ]
  },
  {
@@ -340,7 +340,7 @@
    "\n",
    "When going live with production-level application using CLOVA Studio, you should apply for and use Service App. (See [here](https://guide.ncloud-docs.com/docs/en/clovastudio-playground01#서비스앱신청).)\n",
    "\n",
-    "For a Service App, a corresponding `NCP_CLOVASTUDIO_API_KEY` is issued and can only be called with it."
+    "For a Service App, you should use a corresponding Service API key and can only be called with it."
   ]
  },
  {
@@ -353,7 +353,7 @@
    "# Update environment variables\n",
    "\n",
    "os.environ[\"NCP_CLOVASTUDIO_API_KEY\"] = getpass.getpass(\n",
-    "    \"Enter NCP CLOVA Studio API Key for Service App: \"\n",
+    "    \"Enter NCP CLOVA Studio Service API Key: \"\n",
    ")"
   ]
  },
--- a/docs/docs/integrations/providers/naver.mdx
+++ b/docs/docs/integrations/providers/naver.mdx
@@ -10,7 +10,8 @@ Please refer to [NCP User Guide](https://guide.ncloud-docs.com/docs/clovastudio-

 ## Installation and Setup

- Get both CLOVA Studio API Key and API Gateway Key by [creating your app](https://guide.ncloud-docs.com/docs/en/clovastudio-playground01#create-test-app) and set them as environment variables respectively (`NCP_CLOVASTUDIO_API_KEY`, `NCP_APIGW_API_KEY`).
+- Get a CLOVA Studio API Key by [issuing it](https://api.ncloud-docs.com/docs/ai-naver-clovastudio-summary#API%ED%82%A4) and set it as an environment variable (`NCP_CLOVASTUDIO_API_KEY`).
+    - If you are using a legacy API Key (that doesn't start with `nv-*` prefix), you might need to get an additional API Key by [creating your app](https://guide.ncloud-docs.com/docs/en/clovastudio-playground01#create-test-app) and set it as `NCP_APIGW_API_KEY`.
 - Install the integration Python package with:

 ```bash
--- a/docs/docs/integrations/text_embedding/naver.ipynb
+++ b/docs/docs/integrations/text_embedding/naver.ipynb
@@ -32,15 +32,13 @@
    "\n",
    "1. Creating [NAVER Cloud Platform](https://www.ncloud.com/) account \n",
    "2. Apply to use [CLOVA Studio](https://www.ncloud.com/product/aiService/clovaStudio)\n",
-    "3. Find API Keys after creating CLOVA Studio Test App or Service App (See [here](https://guide.ncloud-docs.com/docs/en/clovastudio-playground01#테스트앱생성).)\n",
+    "3. Create a CLOVA Studio Test App or Service App of a model to use (See [here](https://guide.ncloud-docs.com/docs/clovastudio-explorer03#%ED%85%8C%EC%8A%A4%ED%8A%B8%EC%95%B1%EC%83%9D%EC%84%B1).)\n",
+    "4. Issue a Test or Service API key (See [here](https://api.ncloud-docs.com/docs/ai-naver-clovastudio-summary#API%ED%82%A4).)\n",
    "\n",
    "### Credentials\n",
    "\n",
-    "CLOVA Studio requires 3 keys (`NCP_CLOVASTUDIO_API_KEY`, `NCP_APIGW_API_KEY` and `NCP_CLOVASTUDIO_APP_ID`) for embeddings.\n",
-    "- `NCP_CLOVASTUDIO_API_KEY` and `NCP_CLOVASTUDIO_APP_ID` is issued per serviceApp or testApp\n",
-    "- `NCP_APIGW_API_KEY` is issued per account\n",
-    "\n",
-    "The two API Keys could be found by clicking `App Request Status` > `Service App, Test App List` > `‘Details’ button for each app` in [CLOVA Studio](https://clovastudio.ncloud.com/studio-application/service-app)."
+    "Set the `NCP_CLOVASTUDIO_API_KEY` environment variable with your API key.\n",
+    "  - Note that if you are using a legacy API Key (that doesn't start with `nv-*` prefix), you might need two additional keys to be set as environment variables (`NCP_APIGW_API_KEY` and `NCP_CLOVASTUDIO_APP_ID`. They could be found by clicking `App Request Status` > `Service App, Test App List` > `Details` button for each app in [CLOVA Studio](https://clovastudio.ncloud.com/studio-application/service-app)."
   ]
  },
  {
@@ -56,9 +54,15 @@
    "if not os.getenv(\"NCP_CLOVASTUDIO_API_KEY\"):\n",
    "    os.environ[\"NCP_CLOVASTUDIO_API_KEY\"] = getpass.getpass(\n",
    "        \"Enter NCP CLOVA Studio API Key: \"\n",
-    "    )\n",
-    "if not os.getenv(\"NCP_APIGW_API_KEY\"):\n",
-    "    os.environ[\"NCP_APIGW_API_KEY\"] = getpass.getpass(\"Enter NCP API Gateway API Key: \")"
+    "    )"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b31fc062",
+   "metadata": {},
+   "source": [
+    "Uncomment below to use a legacy API key:"
   ]
  },
  {
@@ -68,7 +72,9 @@
   "metadata": {},
   "outputs": [],
   "source": [
-    "os.environ[\"NCP_CLOVASTUDIO_APP_ID\"] = input(\"Enter NCP CLOVA Studio App ID: \")"
+    "# if not os.getenv(\"NCP_APIGW_API_KEY\"):\n",
+    "#     os.environ[\"NCP_APIGW_API_KEY\"] = getpass.getpass(\"Enter NCP API Gateway API Key: \")\n",
+    "# os.environ[\"NCP_CLOVASTUDIO_APP_ID\"] = input(\"Enter NCP CLOVA Studio App ID: \")"
   ]
  },
  {
@@ -118,8 +124,7 @@
    "from langchain_community.embeddings import ClovaXEmbeddings\n",
    "\n",
    "embeddings = ClovaXEmbeddings(\n",
-    "    model=\"clir-emb-dolphin\",  # set with the model name of corresponding app id. Default is `clir-emb-dolphin`\n",
-    "    # app_id=\"...\"  # set if you prefer to pass app id directly instead of using environment variables\n",
+    "    model=\"clir-emb-dolphin\"  # set with the model name of corresponding app id. Default is `clir-emb-dolphin`\n",
    ")"
   ]
  },
@@ -251,7 +256,7 @@
    "\n",
    "When going live with production-level application using CLOVA Studio, you should apply for and use Service App. (See [here](https://guide.ncloud-docs.com/docs/en/clovastudio-playground01#서비스앱신청).)\n",
    "\n",
-    "For a Service App, corresponding `NCP_CLOVASTUDIO_API_KEY` and `NCP_CLOVASTUDIO_APP_ID` are issued and can only be called with them."
+    "For a Service App, you should use a corresponding Service API key and can only be called with it."
   ]
  },
  {
@@ -266,6 +271,7 @@
    "os.environ[\"NCP_CLOVASTUDIO_API_KEY\"] = getpass.getpass(\n",
    "    \"Enter NCP CLOVA Studio API Key for Service App: \"\n",
    ")\n",
+    "# Uncomment below to use a legacy API key:\n",
    "os.environ[\"NCP_CLOVASTUDIO_APP_ID\"] = input(\"Enter NCP CLOVA Studio Service App ID: \")"
   ]
  },
@@ -279,7 +285,6 @@
    "embeddings = ClovaXEmbeddings(\n",
    "    service_app=True,\n",
    "    model=\"clir-emb-dolphin\",  # set with the model name of corresponding app id of your Service App\n",
-    "    # app_id=\"...\"  # set if you prefer to pass app id directly instead of using environment variables\n",
    ")"
   ]
  },