盘古应用开发SDK使用前准备
使用盘古大模型应用开发SDK时，需要在代码中配置以下信息，请提前收集。
|
类型 |
资源 |
是否必选 |
相关配置项 |
说明 |
配置项值获取方式 |
|---|---|---|---|---|---|
|
IAM认证 |
- |
是 |
sdk.iam.url |
Token认证调用URL。 示例：POST https://{endpoint}/v3/auth/tokens |
{endpoint}获取方式详见《API参考》“使用前必读 > 终端节点” |
|
sdk.iam.domain sdk.iam.user sdk.iam.password sdk.iam.project |
华为云IAM账号认证信息。 |
user name、domain name、project id获取方法如下。 登录“我的凭证 > API凭证”页面，获取user name、domain name、project id。 由于盘古大模型当前部署在“西南-贵阳一”区域，需要获取与“西南-贵阳一”区域对应的project id。
|
|||
|
sdk.iam.ak sdk.iam.sk |
认证用的ak和sk。 |
登录“我的凭证 > 访问密钥”页面，依据界面操作指引获取Access Key（AK）和Secret Access Key（SK）。下载的访问密钥为credentials.csv文件，包含AK/SK信息。
说明：
认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全。 |
|||
|
大语言模型 |
华为云盘古大模型 |
是，且至少选择一个大语言模型 |
sdk.llm.pangu.url |
盘古大模型API调用URL。 完整URL格式示例为：https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/chat/completions SDK配置示例为：https://{endpoint}/v1/{project_id}/deployments/{deployment_id} （/chat/completions在SDK代码中已进行设置）。 |
盘古大模型API调用URL获取方式详见《API参考》“如何调用REST API” |
|
sdk.llm.pangu.iam.url sdk.llm.pangu.iam.domain sdk.llm.pangu.iam.user sdk.llm.pangu.iam.password sdk.llm.pangu.iam.project |
华为云IAM账号认证信息。 |
参考IAM帮助文档，获取账号相关信息：https://support.huaweicloud.com/api-identitycenter/iic_04_0032.html。 |
|||
|
sdk.llm.pangu.model-version |
Agent模型版本号 |
根据使用模型可选N2_agent_v2、N3_agent_v2。 |
|||
|
Embedding模型 |
华为云CSS |
否 |
sdk.embedding.css.url |
CSS Embedding模型API调用URL。 示例：https://{endPoint}/v1/{projectId}/applications/{appId}/{modelVersion} |
CSS Embedding模型API参考文档： 申请资源时，可联系客户支持获取。 |
|
sdk.embedding.css.iam.url sdk.embedding.css.iam.domain sdk.embedding.css.iam.user sdk.embedding.css.iam.password sdk.embedding.css.iam.project |
华为云IAM账号认证信息。 |
参考IAM帮助文档，获取账号相关信息：https://support.huaweicloud.com/api-identitycenter/iic_04_0032.html。 |
|||
|
文档加载 |
华为云CSS |
否 |
sdk.doc.split.css.url |
CSS文档解析服务API调用URL。 示例：https://{endpoint}/v1/{project_id}/applications/{app_id} |
CSS文档解析服务API参考文档：申请资源时，可联系客户支持获取。 |
|
sdk.doc.split.css.filepath |
需要拆分的文档路径。 |
用户需拆分的文档所在路径。 |
|||
|
sdk.doc.split.css.mode |
文档拆分模式 |
可取值如下：
|
|||
|
sdk.doc.split.css.iam.url sdk.doc.split.css.iam.domain sdk.doc.split.css.iam.user sdk.doc.split.css.iam.password sdk.doc.split.css.iam.project |
华为云IAM账号认证信息。 |
参考IAM帮助文档，获取账号相关信息：https://support.huaweicloud.com/api-identitycenter/iic_04_0032.html。 |
|||
|
向量记忆 |
华为云CSS |
否 |
sdk.memory.css.url |
集群host信息。 示例：http://127.0.0.1:9200，http://127.0.0.2:9200 |
参考CSS服务“快速入门”章节创建机器后，在集群信息中获取hosts信息。 |
|
sdk.memory.css.user sdk.memory.css.password |
用户认证信息。 |
创建集群时设置的用户/密码。 |
|||
|
华为云CSS（集成Embedding） |
否 |
sdk.memory.css.url |
集群host信息。 示例：http://127.0.0.1:9200，http://127.0.0.2:9200 |
参考CSS服务“快速入门”章节创建机器后，在集群信息中获取hosts信息。 |
|
|
sdk.memory.css.user sdk.memory.css.password |
用户认证信息。 |
创建集群时设置的用户/密码。 |
|||
|
Elastic Search |
否 |
sdk.memory.css.url |
集群host信息。 示例：http://127.0.0.1:9200，http://127.0.0.2:9200 |
ES官网： https://www.elastic.co/cn/elasticsearch/ |
|
|
sdk.memory.css.user sdk.memory.css.password |
用户认证信息。 |
创建集群时设置的用户/密码。 |
|||
|
标量存储 |
华为云DCS |
否 |
sdk.memory.dcs.url |
host信息。 示例：127.0.0.1:6379 |
分布式缓存DCS： https://support.huaweicloud.com/dcs/index.html |
|
sdk.memory.dcs.user sdk.memory.dcs.password |
用户认证信息。 |
设置的用户/密码。 |
|||
|
Redis |
否 |
sdk.memory.dcs.url |
host信息。 示例：127.0.0.1:6379 |
Redis官网： https://redis.io/ |
|
|
sdk.memory.dcs.user sdk.memory.dcs.password |
用户认证信息。 |
设置的用户/密码。 |
|||
|
华为云RDS |
否 |
sdk.memory.rds.url |
host信息。 示例：jdbc:mariadb://127.0.0.1:3306/sdk?useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai |
云数据库RDS： https://support.huaweicloud.com/rds/index.html |
|
|
sdk.memory.rds.user sdk.memory.rds.password |
用户认证信息。 |
设置的用户/密码。 |
|||
|
Mysql |
否 |
sdk.memory.rds.url |
host信息。 示例：jdbc:mariadb://127.0.0.1:3306/sdk?useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai |
Mysql官网： https://www.mysql.com/ |
|
|
sdk.memory.rds.user sdk.memory.rds.password |
用户认证信息。 |
设置的用户/密码。 |
