BasicAuth插件
users:username:alice password:123456-username:bob password:666666-username:charlie password:888888-username:dave password:111111 BasicAuth插件支持插件数据集 创建插件数据集 登录API网关控制台，左侧栏点击 API管理 —— 插件...
默认展示字段
每一次搜索请求中，应用结构部分字段的召回都可以通过指定“默认展示字段”来限制。控制台配置及生效 1.控制台——>OpenSearch 高性能检索版 ——>功能扩展—->搜索结果展示，添加默认展示字段 2.不配置默认展示字段，在控制台搜索测试，...
后端签名插件
3.插件配置 可以选择JSON或者YAML格式的来配置您的插件，两种格式的schema相同，可以搜索yaml to json转换工具来进行配置格式的转换，YAML格式的模板见下表-type:APIGW_BACKEND key:SampleKey secret:SampleSecret 4.读取 API 网关签名方法...
后端路由
1.配置方式 1.1 配置模板 可以选择JSON或者YAML格式的来配置您的插件，两种格式的schema相同，可以搜索 yaml to json 转换工具来进行配置格式的转换，yaml格式的模板见下表。routes:#当调用方的AppId为"123456"时,路由至独立的地址,例子中...
查询实例状态
本文为您介绍Detail接口的语法及示例，用于根据名称查询图像搜索实例的相关信息。使用说明 本接口用于向图像搜索实例中查询实例信息。说明 如需了解更多产品详情和获取技术支持，请单击 在线咨询 或通过钉钉群（35035130）联系我们。QPS...
默认展示字段
每一次搜索请求中，应用结构部分字段的召回都可以通过指定“默认展示字段”来限制。控制台配置及生效 1.控制台——>扩展功能—->搜索结果展示，添加默认展示字段 2.不配置默认展示字段，在控制台搜索测试，仍然可以使用如下方法展示字段：...
API/SDK数据导入
2.API/SDK不支持设置数据源插件，请自行拼接、处理后传入OpenSearch应用中。比如，array类型使用API上传时，注意不要上传为string格式，而是上传为数组类型。例：/定义Map对象存储上传文档数据,此为文档2 Map,Object>doc2=Maps....
实例详情
每个地域的API域名不同，使用API或者SDK访问OpenSearch的时候需要根据此处给出的API入口进行访问。不同地域也根据使用的场景区分了内网API域名（同区域（含VPC）环境下的ECS可用）、公网API域名（公网环境下使用），请根据实际部署情况选择...
OpenSearch产品选型
数据更新 API/SDK更新，和订阅DTS自动同步更新 API/SDK更新，或订阅DTS自动同步更新 API/SDK更新 API/SDK更新 数据备份 应用无数据源时，支持继承线上应用数据 不支持 API数据源，支持从历史索引恢复数据 API数据源，支持从历史索引恢复...
请求结构
服务地址 OpenSearch为分区域部署，每个区域访问地址均不同，具体服务地址请查看访问应用-》基本详情中的API入口部分获取，切勿随便使用。通信协议 支持HTTP协议。部分区域（华北1、华北2、华东1、华东2、华南1）已支持HTTPS协议。请求方法...
restful api文档搜索Demo
通过SDK 调用问天搜索引擎进行数据检索。通用代码示例 import com.aliyun.ha3engine.Client;import com.aliyun.ha3engine.models.*;import com.aliyun.tea.TeaException;import java.util.ArrayList;import java.util.HashMap;import java....
流量控制插件
当取值为 API 时：流控策略在每个API中分别生效，在本例子中，每个API的限流均为 10次/秒 当取值为 PLUGIN 时：所有绑定了本插件的API共享这个限流，如果本例子中的插件绑定了一堆API，则这一堆API的总流控限制为 10次/秒 parameters（必选...
图片新增
本文介绍图像搜索服务新增图片的四种方式，控制台图片新增（适用于功能体验场景）、通过API新增、SDK新增（适用于小规模、实时的数据增量操作）、批量操作（适用于较大规模（百万级）、离线数据操作）。请根据您的实际情况进行选择。说明 ...
搜索结果摘要
一般文档内容会比较长，而在实际展示搜索结果的时候，不可能完全展示出来。这时候就需要做摘要及飘红设置。系统会截取包含搜索结果的几个片段，供用户了解具体匹配内容，以快速判断是否是自己想要的结果。用户可以在控制台对搜索结果的展示...
缓存插件
通过缓存可以将后端返回的应答缓存在API网关服务层面，有效降低后端的负荷，增加平滑度。1.使用方法 仅缓存 GET 方法的应答 不缓存使用 默认分组二级域名 的请求，默认分组二级域名有1000次/天的限制（海外Region及中国香港限制100次/天）...
API/SDK数据导入
OpenSearch中的数据，既支持数据源导入，也支持无数据源，通过API/SDK/控制台上传文件的方式导入数据。通过API/SDK导入非常灵活，完全由用户控制。字段类型对应关系 OpenSearch 字段类型 API推送字段类型 INT int、long INT_ARRAY int[]、...
ListQueryResult-获取搜索测试结果
获取搜索测试结果。接口说明 方法 GET URI/openapi/ha3/instances/{instanceId}/query?query=xxxx 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 ...
restful api文档搜索Demo
通过SDK 调用问天搜索引擎进行数据检索。通用代码示例 import com.aliyun.ha3engine.Client;import com.aliyun.ha3engine.models.*;import com.aliyun.tea.TeaException;import java.util.ArrayList;import java.util.HashMap;import java....
搜索结果摘要
一般文档内容会比较长，而在实际展示搜索结果的时候，不可能完全展示出来。这时候就需要做摘要及飘红设置。系统会截取包含搜索结果的几个片段，供用户了解具体匹配内容，以快速判断是否是自己想要的结果。用户可以在控制台对搜索结果的展示...
使用HTTP请求接口代码示例
本文档介绍API访问实例的样例程序。通过API访问实例的Java样例程序，请单击 API样例 进行下载。其中Api2Demo.java是图像搜索V2版本searchByUrl、getProductInfoByIds接口示例。
新增图片
本文为您介绍AddImage接口的语法及示例，用于向图像搜索实例中添加图片信息。使用说明 本接口用于向图像搜索实例中添加图片信息。说明 如需了解更多产品详情和获取技术支持，请单击 在线咨询 或通过钉钉群（35035130）联系我们。QPS限制 10...
API 数据源
本文将介绍以API为数据源时如何添加表。添加表 在 实例详情>表管理页，点击 添加表：填写表的基础信息，点击 下一步：配置说明：表名称：可自定义 数据分片数：分片数设置时，各索引表分片数需保持一致；或至少一个索引表分片数为1，其余...
公网访问API域名方法
1、查看所需访问的Ha3实例域名对应的IP 登录OpenSearch-召回引擎版控制台，找到对应的实例，查看API域名地址。登录ha3实例中配置的专有网络，登录一台ECS机器，使用ping命令ping ha3实例的API域名，获取对应的地址。2、创建公网NAT网关 ...
搜索Demo（基本）
指定一个应用用于搜索$params->setAppName('替换为应用名');指定搜索关键词$params->setQuery("name:'搜索'");指定返回的搜索结果的格式为json$params->setFormat("fulljson");添加排序字段$params->addSort('RANK',SearchParamsBuilder:...
从索引中恢复数据
功能介绍 由于API推送数据源在进行全量后，之前通过API推送的数据最多只能回追3天的数据，因此为保证用户API推送数据的完整性，召回引擎版提供了从当前全量版本中恢复数据的功能，保证用户API推送的数据可以在下一次全量版本中保留，其原理...
批量操作
本文为您介绍IncreaseInstance接口的语法及示例，用于根据名称新建图像搜索实例批量任务。使用说明 本接口用于向图像搜索实例中提交批量任务。说明 如需了解更多产品详情和获取技术支持，请单击 在线咨询 或通过钉钉群（35035130）联系我们...
下载中心
Java SDK 提供Java语言对API接口的封装（数据处理、搜索等），其他功能请使用下文中的管控SDK。groupId>...
从索引中恢复数据
功能介绍 由于API推送数据源在进行全量后，之前通过API推送的数据最多只能回追3天的数据，因此为保证用户API推送数据的完整性，向量检索版提供了从当前全量版本中恢复数据的功能，保证用户API推送的数据可以在下一次全量版本中保留，其原理...
搜索Demo（基本）
指定一个应用用于搜索$params->setAppName('替换为应用名');指定搜索关键词$params->setQuery("name:'搜索'");指定返回的搜索结果的格式为json$params->setFormat("fulljson");添加排序字段$params->addSort('RANK',SearchParamsBuilder:...
QueryEvaluateList-待开票对象查询服务
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
版本说明
提供Python语言仅对流量API接口的封装（数据处理、搜索），其他功能请使用管控SDK。依赖 pip install alibabacloud-ha3engine 变更日志 v 1.3.4(2023-06-09)修复sql的kvpair默认分隔符';' v 1.3.3(2023-02-23)支持restful api查询方式 支持...
删除图片
本文为您介绍DeleteImage接口的语法及示例，用于向图像搜索实例中删除图片信息。使用说明 本接口用于向图像搜索实例中删除图片信息。说明 如果指定图片在图像搜索实例中不存在，该接口依然会返回成功。不能用返回结果来判断图片是否存在。...
元数据导出
本文为您介绍DumpMeta接口的语法及示例，用于根据名称新建图像搜索元信息导出任务。使用说明 本接口用于向图像搜索实例中提交元信息导出任务。说明 如需了解更多产品详情和获取技术支持，请单击 在线咨询 或通过钉钉群（35035130）联系我们...
图片删除
背景信息 目前图像搜索服务提供四种图片信息删除方式，通过API删除、SDK删除（适用于小规模、实时的数据删除操作）、批量操作（适用于较大规模、离线数据删除操作）和在控制台进行一键删除（适用于一次性将实例中所有图片都删除的场景）。...
基于向量检索版+LLM构建对话式搜索
背景 随着生成式AI技术“火爆出圈”，预示着人工智能未来发展趋势的同时，也为我国人工智能市场注入源源不断的活力，更多企业关注如何将“超级工具”应用到实际业务中去，生成式人工智能技术在通用任务上表现优秀，但面对垂直业务领域，还...
API概览
应用实例 API 标题 API概述 应用管理 应用管理 RenewAppGroup 为应用续费（暂不支持）为应用续费（续费暂不支持API调用，请在控制台操作续费）。CreateAppGroup 创建一个应用 创建一个OpenSearch应用。ModifyAppGroup 修改应用属性或设置...
版本说明
提供Java语言仅对流量API接口的封装（数据处理、搜索），其他功能请使用管控SDK。Maven依赖<dependency><groupId>com.aliyun</groupId> <artifactId>aliyun-sdk-ha3engine</artifactId> <version>1.3.4</version> </dependency>变更日志 v 1.3...
JWT认证插件
Json Web Token(RFC7519),是一种便捷的可用于网关进行请求认证的鉴权方案，API 网关 可以通过托管用户的 Public JWK 实现对请求进行JWT认证，并将 claims 作为后端参数转发给后端，以方便用户简化开发后端应用的开发。本文主要是JWT认证...
下载中心
Java SDK 提供Java语言对API接口的封装（数据处理、搜索等），其他功能请使用下文中的管控SDK。groupId>...
版本说明
提供Python语言仅对流量API接口的封装（数据处理、搜索），其他功能请使用管控SDK。依赖 pip install alibabacloud-ha3engine 变更日志 v 1.3.6(2023-11-13)sql查询和ha查询支持post请求方式 v 1.3.5(2023-07-12)支持内网环境指定swift、...
- 产品推荐
- 这些文档可能帮助您