Skip to content

Commit 135bf9e

Browse files
committed
add more links and explaination
1 parent 544d7f4 commit 135bf9e

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

veadk_tutorial.ipynb

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,13 @@
8282
"### 环境变量"
8383
]
8484
},
85+
{
86+
"cell_type": "markdown",
87+
"metadata": {},
88+
"source": [
89+
"这里以[方舟大模型平台](https://console.volcengine.com/ark/region:ark+cn-beijing/overview)为例,使用到的模型需要提前在方舟控制台进行[开通操作](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement)。"
90+
]
91+
},
8592
{
8693
"cell_type": "code",
8794
"execution_count": null,
@@ -92,7 +99,7 @@
9299
"source": [
93100
"import os\n",
94101
"\n",
95-
"os.environ[\"MODEL_AGENT_NAME\"] = \"doubao-seed-1-6-250615\" # <-- 火山方舟大模型名称\n",
102+
"os.environ[\"MODEL_AGENT_NAME\"] = \"doubao-seed-1-6-251015\" # <-- 火山方舟大模型名称\n",
96103
"\n",
97104
"os.environ[\"MODEL_AGENT_API_KEY\"] = \"\" # <-- 设置火山方舟的API KEY来访问模型\n",
98105
"\n",
@@ -238,7 +245,7 @@
238245
"id": "JDtvFNcAy9FK"
239246
},
240247
"source": [
241-
"使用[`web_search`工具](https://www.volcengine.com/docs/85508/1650263),使用前需提前填写火山引擎的 AK 和 SK:"
248+
"使用[`web_search`工具](https://www.volcengine.com/docs/85508/1650263),使用前需提前开通[相应权限](https://www.volcengine.com/docs/85508/1544858) (简单起见,可以直接给用到的测试账号赋予[AdministratorAccess超管权限](https://console.volcengine.com/iam/policymanage/System/AdministratorAccess?tab=auth)),提前[创建并填写火山引擎的 AK 和 SK](https://www.volcengine.com/docs/6291/65568)"
242249
]
243250
},
244251
{
@@ -313,7 +320,7 @@
313320
"id": "IoTXmqz8zAvp"
314321
},
315322
"source": [
316-
"尝试使用[`VeSearch`工具](https://www.volcengine.com/docs/85508/1512748),使用前需进行[工具创建](https://console.volcengine.com/ask-echo/my-agent),并填写如下 `VeSearch` 工具的 ENDPOINT 和 API KEY:"
323+
"尝试使用[`VeSearch`工具](https://www.volcengine.com/docs/85508/1512748),使用前需进行[工具创建](https://console.volcengine.com/ask-echo/my-agent),并填写如下 `VeSearch`工具的 ENDPOINT (ID) 和 API KEY:"
317324
]
318325
},
319326
{
@@ -691,7 +698,7 @@
691698
"id": "aEFDAJdtiiz1"
692699
},
693700
"source": [
694-
"使用 [Viking Memory](https://www.volcengine.com/docs/84313/1860687) 作为长期记忆的后端,使用前[创建 Viking Memory](https://console.volcengine.com/vikingdb/region:vikingdb+cn-beijing/home?) 并填写如下信息:"
701+
"使用 [记忆库/Viking Memory](https://www.volcengine.com/docs/84313/1860687) 作为长期记忆的后端,使用前[创建 记忆库/Viking Memory](https://console.volcengine.com/vikingdb/region:vikingdb+cn-beijing/home?) 并填写如下信息:"
695702
]
696703
},
697704
{
@@ -937,7 +944,7 @@
937944
"id": "V87HcIZXlijp"
938945
},
939946
"source": [
940-
"使用 [Viking DB](https://www.volcengine.com/docs/84313/1254463) 作为知识库的后端,使用前[创建 Viking DB](https://console.volcengine.com/vikingdb/region:vikingdb+cn-beijing/home?) 和 [TOS](https://www.volcengine.com/docs/6349) 并填写如下信息:"
947+
"使用 [知识库/Viking DB](https://www.volcengine.com/docs/84313/1254463) 作为后端,使用前[创建 知识库/Viking DB](https://console.volcengine.com/vikingdb/region:vikingdb+cn-beijing/home?) 和 [TOS](https://www.volcengine.com/docs/6349/74830) 并填写如下信息:"
941948
]
942949
},
943950
{
@@ -1338,7 +1345,7 @@
13381345
"id": "9j9aqke52nCz"
13391346
},
13401347
"source": [
1341-
"需要设置上报器(exporter),VeADK 当前支持将 Tracing 数据上报至[火山引擎 TLS](https://www.volcengine.com/product/tls)、[火山引擎 APMPlus](https://www.volcengine.com/product/apmplus) 以及[火山引擎 Coze Loop](https://www.coze.cn/loop) 平台。它们分别对应不同的上报器。"
1348+
"需要设置上报器(exporter),VeADK 当前支持将 Tracing 数据上报至[火山引擎 Coze Loop](https://www.coze.cn/loop)、[火山引擎 TLS](https://www.volcengine.com/product/tls) 以及 [火山引擎 APMPlus](https://www.volcengine.com/product/apmplus) 平台。它们分别对应不同的上报器。"
13421349
]
13431350
},
13441351
{
@@ -1347,7 +1354,7 @@
13471354
"id": "azFOHaFe3C5x"
13481355
},
13491356
"source": [
1350-
"初始化上报器之前需要进行环境变量设置:"
1357+
"初始化上报器之前需要进行环境变量设置,相应的获取方式可参考 [Coze Loop](https://loop.coze.cn/open/docs/cozeloop/veadk_trace_report)、[TLS](https://www.volcengine.com/docs/6470/72004)、[APMPlus](https://www.volcengine.com/docs/6431/1469364)"
13511358
]
13521359
},
13531360
{
@@ -1359,27 +1366,26 @@
13591366
"outputs": [],
13601367
"source": [
13611368
"import os\n",
1369+
"# Coze Loop 上报器环境变量\n",
1370+
"os.environ[\"OBSERVABILITY_OPENTELEMETRY_COZELOOP_ENDPOINT\"] = (\n",
1371+
" \"https://api.coze.cn/v1/loop/opentelemetry/v1/traces\"\n",
1372+
")\n",
1373+
"os.environ[\"OBSERVABILITY_OPENTELEMETRY_COZELOOP_SERVICE_NAME\"] = \"\" # 工作空间/workspace id\n",
1374+
"os.environ[\"OBSERVABILITY_OPENTELEMETRY_COZELOOP_API_KEY\"] = \"\" # 令牌/token\n",
13621375
"\n",
13631376
"# TLS 上报器环境变量\n",
13641377
"os.environ[\"OBSERVABILITY_OPENTELEMETRY_TLS_ENDPOINT\"] = (\n",
13651378
" \"https://tls-cn-beijing.volces.com:4318/v1/traces\"\n",
13661379
")\n",
13671380
"os.environ[\"OBSERVABILITY_OPENTELEMETRY_TLS_REGION\"] = \"cn-beijing\"\n",
1368-
"os.environ[\"OBSERVABILITY_OPENTELEMETRY_TLS_SERVICE_NAME\"] = \"\"\n",
1381+
"os.environ[\"OBSERVABILITY_OPENTELEMETRY_TLS_SERVICE_NAME\"] = \"\" # TLS 主题/topic id\n",
13691382
"\n",
13701383
"# APMPlus 上报器环境变量\n",
13711384
"os.environ[\"OBSERVABILITY_OPENTELEMETRY_APMPLUS_ENDPOINT\"] = (\n",
13721385
" \"http://apmplus-cn-beijing.volces.com:4317\"\n",
13731386
")\n",
13741387
"os.environ[\"OBSERVABILITY_OPENTELEMETRY_APMPLUS_SERVICE_NAME\"] = \"\"\n",
1375-
"os.environ[\"OBSERVABILITY_OPENTELEMETRY_APMPLUS_API_KEY\"] = \"\"\n",
1376-
"\n",
1377-
"# Coze Loop 上报器环境变量\n",
1378-
"os.environ[\"OBSERVABILITY_OPENTELEMETRY_COZELOOP_ENDPOINT\"] = (\n",
1379-
" \"https://api.coze.cn/v1/loop/opentelemetry/v1/traces\"\n",
1380-
")\n",
1381-
"os.environ[\"OBSERVABILITY_OPENTELEMETRY_COZELOOP_SERVICE_NAME\"] = \"\"\n",
1382-
"os.environ[\"OBSERVABILITY_OPENTELEMETRY_COZELOOP_API_KEY\"] = \"\""
1388+
"os.environ[\"OBSERVABILITY_OPENTELEMETRY_APMPLUS_API_KEY\"] = \"\" # app key"
13831389
]
13841390
},
13851391
{

0 commit comments

Comments
 (0)