- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
- AppStage使用前准备
- AI原生应用引擎用户指南
- 开发中心用户指南
-
运维中心用户指南
- 运维中心简介
- 运维中心使用前准备
- 运维中心使用流程
- 进入运维中心
- 接入资源
- 部署应用
- 监控资源和应用
- 管理已纳管资源
- 管理运行时资源
- 管理工单
- 运营中心用户指南
- 最佳实践
- 开发指南
- API参考
- SDK参考
-
常见问题
- 权限管理
-
AI原生应用引擎
- 我创建的微调数据集会被其他用户调用去训练他们的大模型吗？
- 模型微调任务一直在等待中是什么原因？
- 大模型微调需要的数据有要求吗？
- AI原生应用引擎支持所有数据集进行数据标注吗？
- AI原生应用引擎中预置了哪些提示语？
- AI原生应用引擎训练好后的模型如何获取？
- 模型调测时，无法选择模型服务商API是什么原因？
- 我接入的模型需要满足什么要求才能在创建Agent时作为思考模型？
- Agent问答的时候报错“很抱歉，我的系统似乎遇到了一些故障问题，暂时无法为您提供服务”
- 自接入的模型在模型调测的时候报错是什么原因？
- 开源模型怎么部署？
- 平台有没有预置模型？
- 思考模型和问答模型的区别
- 工作流中知识库节点、LLM节点都需要配置实例，实例的API Key填什么?
- 工作流中工具节点的实例如何配置?
- 如何获取Agent发布时所需的API Key？
- 如何保证Agent每次问答都调用知识库?
- 工作流的返回是json格式，但是大模型会进行总结，如何以json格式直接输出?
- 如何在工作流中定制逻辑实现特定任务，比如时间格式转换、数组对象的push等
- 资产中心的工具怎么使用?
- Code代码节点的输入输出参数如何与其他节点进行交互和传递?
- Agent问答的时候没有回答
- 发布Agent的时候提示套餐校验失败
- 一站式创建Agent时如何取消选择默认模型，更换为其他模型
- 按照标题切分的时候，分段长度是什么意思?
- 工作流已启用，为什么在创建Agent时仍然无法选用？
- 如何通过调用Agent API将变量传递到工作流？
- 开发中心
- 运维中心部署服务
-
运维中心监控服务
- 如何查看EAP详细日志？
- 删除告警任务失败
- 告警后触发知识编排任务提示alert_type不存在
- 创建CES指标采集报错
- 如何卸载虚拟机上安装的filebeat？
-
异常检测Judge定时任务失败
- KeyError
- TypeError: not supported between instances of 'str' and 'float'
- TypeError("Cannot index by location index with a non-integer key")
- judge长时间处于SUBMIT状态直至失败
- fail to load model json
- judge日志无法查看，提示get request error
- judge日志大小1KB，且不刷新日志内容
- PSQLException: ERROR: invalid input syntax for type numeric
- PSQLException: ERROR: syntax error at or near
- too much null size
- judge_data_size(in):0
- ERROR - fail to load
- canceling statement due to user request
- 保存异常检测告警配置时报错
- 运维中心弹性资源服务
- 运维中心弹性网络服务
- 运维中心主机管理服务
- 运维中心微服务平台
-
运维中心负载均衡
-
SLB同步异常相关问题
- SSL_do_handshake() failed
- test nginx: nginx: [emerg] host not found in upstream "后端服务器名称" in /.../server...conf:17 nginx: .../nginx.conf test failed [FAILED
- no "ssl_certificate" is defined for the "listen ... ssl""
- no such file or directory......./ssl/dummy.pem
- test nginx: nginx: [alert] mmap(MAP_ANON|MAP_SHARED, 524288000) failed (12: Cannot allocate memory) nginx: [alert] munmap(FFFFFFFFFFFFFFFF, 524288000) failed
- duplicate value "error" in /opt/huawei/openresty/nginx/.../xxx.conf:40
- SLB同步检查不一致
- SLB一直同步，心跳异常
-
SLB部署失败相关问题
- FATAL Can't get local ip
- /etc/rc.d/init.d/functions: No such file or directory
- nginx is stopped
- will_upgrade\old_version:1.4.7
- Need to modify /etc/hosts,but no permission.
- system param fs.nr_open should not less than fs.file-max”or“system param net.ipv4.ip_local_port_range should >=30000
- some permission denied files in /opt/huawei/openresty/nginx/conf/
- Permission denied: '/opt/huawei/release/lf_test/SLB/
- install_slb_failed for /opt/huawei/openresty exists not for slb
- not all conf included in vhosts or slb_conf
- watchdog still running
- job 28e7241e42904334b failed
- [Service proxy.apply_sudo._wrapped_f]: fail to operator sudo,message: send request fail, status code: 400, error: None, message: illegal param\",\"status\":-2}
- some html not in /opt/huawei/openresty/nginx/html
- cannot access /opt/huawei/openresty/nginx/conf/ssl/sample/resty-auto-ssl-fallback.pem.Permission denined
- fail to operator sudo, message: send request fail, status code: 400, task: control sudo permission, status: failed
- some certificate not in /opt/huawei/openresty/nginx/conf/ssl
- crontab -l \n+ echo 'Permission denied crontab'
- 资源间绑定服务不一致
-
SLB同步异常相关问题
- 运维中心数据库治理
- 运维中心访问凭据管理服务
- 运营中心
- 管理控制台用户指南（即将下线）
- 业务控制台用户指南（即将下线）
-
运行时引擎用户指南（即将下线）
- AppStage运行时引擎简介
- AppStage运行时引擎使用前准备
- 进入AppStage运行时引擎
- 通过微服务平台管理微服务及相关资源
- 配置运行时引擎负载均衡
- 管理Cloud Map中的服务资源
- 配置运行时引擎数据库治理
- 配置访问凭据管理服务
- 文档下载
- 通用参考
链接复制成功！
检索知识库数据
功能介绍
检索知识库数据，根据用户提供的检索信息，返回命中的信息数据。
调用方法
请参见如何调用API。
URI
POST https://aiae.appstage.myhuaweicloud.com/v1/knowledge-bases/{knowledge_base_id}/embed-datas
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
knowledge_base_id |
是 |
String |
参数解释： 知识库id。获取方式： 1.可从创建知识库接口返回获取； 2.进入AI原生应用引擎，在左侧导航栏选择“知识中心 > 知识库”，可从页面知识库ID栏获取。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字以及“-”组成，且长度为36个字符。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Authorization |
是 |
String |
参数解释： 鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
keyword |
否 |
String |
参数解释： 搜索关键字，用于检索匹配结果。 约束限制： 不涉及。 取值范围： 可以为null，如果不为null，字符串长度介于0到2048之间。 默认取值： 不涉及。 |
|
similarity_min |
否 |
Float |
参数解释： 相似度最小值，数值越大表示相似度越高。 约束限制： 不涉及。 取值范围： 可以为null，如果不为null，取值[0, 1]。 默认取值： 不涉及。 |
|
limit |
是 |
Integer |
参数解释： 检索返回切片限制数量。 约束限制： 不涉及。 取值范围： 非空，取值[1, 100]，默认上限100。 默认取值： 不涉及。 |
|
filter |
否 |
Object |
参数解释： 过滤条件。 约束限制： 不涉及。 取值范围： 可以为null，如果不为null，则为SearchSqlFilter类对象。 默认取值： 不涉及。 |
|
order_by |
否 |
Object |
参数解释： 排序规则。 约束限制： 不涉及。 取值范围： 可以为null，如果不为null，则为SqlOrder对象。 默认取值： 不涉及。 |
|
data_sets |
否 |
Array of DataSetSearchInfo objects |
参数解释： 检索的数据集信息，用于指定检索知识库中部分数据集。 约束限制： 不涉及。 取值范围： 可以为null，如果不为null，则为DataSetSearchInfo对象列表，且数量介于1到10之间。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
group_type |
否 |
String |
参数解释： 过滤条件运算符。 约束限制： 只有一个expression时，不需要group_type，group_type可以为null。 取值范围： 可以为null，如果不为null，枚举值AND和OR。 默认取值： 不涉及。 |
|
expressions |
是 |
Array of Expression objects |
参数解释： 过滤条件。 约束限制： 不涉及。 取值范围： 非空，条件数量介于1到10之间。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
field |
是 |
String |
参数解释： 过滤字段。 约束限制： 需以“metadata.”开头，后续可接上path、order、file_name以及索引配置时配置的文本过滤字段，如metadata.path、metadata.answer（假设answer为配置的文本过滤字段）。 取值范围： 非空，字段名称长度介于1到100之间。 默认取值： 不涉及。 |
|
field_type |
是 |
String |
参数解释： 过滤字段类型。 约束限制： 不涉及。 取值范围： 非空，枚举值：INT、FLOAT、BOOLEAN和STRING，取值视field的类型而定。 默认取值： 不涉及。 |
|
operator |
是 |
String |
参数解释： 过滤操作符。 约束限制： 不涉及。 取值范围： 非空，枚举值：EQUAL（等于）、NOT_EQUAL（不等于）、GREAT_THAN（大于）、GREAT_EQUAL（大于等于）、LESS_THAN（小于）、LESS_EQUAL（小于等于）、IN（在xxx之间）、NOTIN（不在xxx之间）和STARTS_WITH（以xxx开头）。 默认取值： 不涉及。 |
|
values |
是 |
Array of strings |
参数解释： 过滤值。 约束限制： 不涉及。 取值范围： 非空，数量介于1到100之间，每个字符串长度最大不超过2000。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
order_items |
是 |
Array of OrderItem objects |
参数解释： 排序规则。 约束限制： 不涉及。 取值范围： 非空，数量介于1到10之间。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
field |
是 |
String |
参数解释： 排序字段。 约束限制： 不涉及。 取值范围： 非空，字符串长度介于1到100之间。 默认取值： 不涉及。 |
|
field_type |
否 |
String |
参数解释： 排序字段类型。 约束限制： 不涉及。 取值范围： 可以为null，如果不为null，枚举值：INT、FLOAT、BOOLEAN和STRING。 默认取值： STRING。 |
|
order_type |
是 |
String |
参数解释： 排序类型。 约束限制： 不涉及。 取值范围： 不为null，枚举值：ASC（升序）和DESC（降序）。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
data_set_id |
否 |
String |
参数解释： 知识数据集id，获取方式： 1.创建知识数据集接口返回值即为知识数据集id。 2.进入AI原生应用引擎，在左侧导航栏选择“知识中心 > 知识库”，选择页面右上角的“... > 知识数据集”，在数据集列表中，单击数据集名称，进入详情页即可获取数据集ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字以及“-”组成，且长度为36个字符。 默认取值： 不涉及。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
Array of ChunkData objects |
参数解释： 知识库检索响应数据。 取值范围： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释： 切片id。 取值范围： 由数字、字母和中划线组成，长度36。 |
|
document |
String |
参数解释： 向量化内容。 取值范围： 不涉及。 |
|
chunk |
String |
参数解释： 完整切片内容。若用户在创建索引时配置了chunk作为检索附加字段，则检索时在此返回。 取值范围： 不涉及。 |
|
chunk_fragments |
Map<String,String> |
参数解释： 附加返回字段及内容（map类型，key为附加返回字段名称，value为附加返回字段内容），若用户在创建索引时配置了除chunk之外的附加返回字段，则字段名称及内容检索时在此返回。 取值范围： 不涉及。 |
|
similarity |
Float |
参数解释： 向量化内容（document）和检索关键字（keyword）的向量相似度门槛，只有相似度大于等于similarity才会返回。 取值范围： 大小为[0,1]。 |
|
metadata |
metadata object |
参数解释： 切片元数据信息，若用户在创建索引时选择文本过滤字段，则该字段及其内容会作为元数据一部分返回。 取值范围： 不涉及。 |
|
download_addresses |
Map<String,String> |
参数解释： 图片或视频临时下载地址（map类型，key为文件路径，value为下载地址）。 取值范围： 不涉及。 |
|
download_address |
String |
参数解释： 废弃字段，请使用download_addresses。 取值范围： 不涉及。 |
|
data_set_id |
String |
参数解释： 切片所属知识数据集id。 取值范围： 由数字、字母和中划线组成，长度36。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
order |
Integer |
参数解释： 切片序号。 取值范围： 不涉及。 |
|
file_name |
String |
参数解释： 文件名称。 取值范围： 不涉及。 |
|
path |
String |
参数解释： 文件相对路径。 取值范围： 不涉及。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释： 异常错误码。 取值范围： 不涉及。 |
|
error_msg |
String |
参数解释： 异常错误信息。 取值范围： 不涉及。 |
请求示例
{
"keyword" : "户外",
"similarity_min" : "0.78",
"limit" : 10,
"filter" : {
"group_type" : "AND",
"expressions" : [ {
"field" : "metadata.answer",
"field_type" : "STRING",
"operator" : "EQUAL",
"values" : [ "我是xxx。" ]
} ]
},
"order_by" : {
"order_items" : [ {
"field" : "metadata.order",
"field_type" : "INT",
"order_type" : "DESC"
} ]
},
"data_sets" : [ {
"data_set_id" : "a31ed909-xxxx-xxxx-xxxx-10958c90b3f7"
} ]
}响应示例
状态码： 200
OK。
{
"data" : [ {
"id" : "812857ef-xxxx-xxxx-xxxx-24ba9fd5e95c",
"document" : "问题：你是谁。回答：我是xxx。回答用户id：000。",
"chunk" : "问题：你是谁。回答：我是xxx。回答用户id：000。",
"chunk_fragments" : {
"question" : "你是谁。",
"answer" : "我是xxx。"
},
"similarity" : 0.87,
"metadata" : {
"order" : 10,
"file_name" : "户外运动热度大大带动各相关产业发展.docx",
"path" : "户外运动热度大大带动各相关产业发展.docx",
"question" : "你是谁。",
"answer" : "我是xxx。"
},
"download_addresses" : {
"xxx.png" : "https://xxxx"
},
"download_address" : null,
"data_set_id" : "3967c49d-xxxx-xxxx-xxxx-5eda056a1f1b"
} ]
}状态码： 500
服务器内部错误或三方服务器内部错误。
{
"error_code" : "AIAE.00001500",
"error_msg" : "系统内部错误。"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK。 |
|
500 |
服务器内部错误或三方服务器内部错误。 |
错误码
请参见错误码。
