通过API使用KooSearch实现搜索问答

场景描述

KooSearch服务开通成功后，会自动创建KooSearch API。在KooSearch服务详情页的API管理页签，可以看到知识管理和文档解析两类API。

• 知识管理：该类API主要用于知识库管理，例如上传文档、刷新文档等。
• 文档解析：该类API主要用于对文档数据进行处理，例如切分文档内容。

将KooSearch API发布到不同环境后，支持在环境中调用API使用KooSearch服务。操作流程如下：

1. 在APIG服务配置API网关：配置API网关。
2. 在CSS服务发布KooSearch API：发布KooSearch API。
3. 在业务环境中调用已发布的KooSearch API：调用已发布的KooSearch API。

当已发布的KooSearch API需要修改安全认证方式时，可以编辑API。

当已发布的KooSearch API不希望被调用时，可以下线API。

配置API网关

1. 创建实例：使用API网关，需要先购买实例。
   

   实例需要跟KooSearch服务在同一个VPC和子网。

2. 创建API分组：API分组相当于API的集合，您在创建API前，需要先创建API分组。
3. 创建环境：API可以同时提供给不同的场景调用，如生产环境（RELEASE）及其他自定义环境。RELEASE是默认存在的环境，无需创建。

发布KooSearch API

将KooSearch API发布到环境。

1. 进入KooSearch服务详情页面。
   1. 登录云搜索服务管理控制台。
   2. 在左侧导航栏选择“KooSearch>Flexus企业搜索服务”，进入KooSearch服务列表。
   3. 选择目标服务，单击服务名称，进入服务详情页。
2. 单击“API管理”，进入API管理页签。
3. 选择待发布的API，单击操作列的“发布”。
4. 在“发布”页面配置API网关信息。

   表1 发布服务

   参数	说明
   实例	发布为APIG的实例。API网关（API Gateway）是为企业和开发者提供的高性能、高可用、高安全的云原生网关服务，能快速将企业服务能力包装成标准API接口，帮助您轻松构建、管理和部署任意规模的API，并上架API云商店进行售卖。借助API网关，可以简单、快速、低成本、低风险地实现内部系统集成和业务能力开放。API网关帮助您变现服务能力的同时，降低企业研发投入，让您专注于企业核心业务，提升运营效率。 如果您作为API提供者，您可以将成熟的业务能力（如虚拟机集群、数据、微服务集群等）作为后端服务，在API网关中开放API，并通过线下方式提供给API调用者使用，或者发布到API云商店，实现业务能力变现。
   发布环境	选择一个发布策略，通过策略的方式，为API提供灵活的控制策略和扩展能力。
   分组	选择一个分组，API分组相当于API的集合，API提供者以API分组为单位，管理分组内的所有API。 说明： API分组发布后不可修改，请谨慎选择。
   配置委托	通过委托信任功能，您可以将自己账号中的资源操作权限委托给更专业、高效的其他账号，被委托的账号可以根据权限代替您进行资源运维工作。可以选择默认委托和自定义委托。 默认委托：选择系统自带的默认委托。 自定义委托：选择自定义委托的话，需要先创建委托 。通过创建委托，可以将资源共享给其他账号，或委托更专业的人或团队来代为管理资源。被委托方使用自己的账号登录后，切换到委托方账号，即可管理委托方委托的资源，避免委托方共享自己的安全凭证（密码/密钥）给他人，确保账号安全。
   安全认证	选择API认证方式。 “APP认证”：表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。 当选择“APP认证”时，需要配置“APP凭据”。 “APP凭据”：使用APP认证的API，需要在API网关中创建一个凭据，以生成凭据ID和密钥对（Key、Secret）。将创建的凭据绑定API后，才可以使用APP认证调用API。客户端（API调用者）在调用API过程中，把密钥对替换SDK中的密钥对，API网关服务根据密钥对进行身份核对，完成鉴权。具体创建凭据的步骤，请参考创建凭据 。 “华为IAM认证”：表示借助IAM服务进行安全认证。 说明： 选择“华为IAM认证”时，任何API网关租户均可以访问此API，可能存在恶意刷流量，导致过量计费的风险。

5. 单击“确定”。

   当API的“状态”变成“已发布”时，表示该API已发布到环境，支持被调用。

调用已发布的KooSearch API

在业务环境中调用已发布的KooSearch API。

1. 构造API请求，KooSearch API的请求说明请参见《API参考》。
2. 为API请求添加认证信息。

   表2 认证方式

   认证方式	API请求参数配置
   APP认证	表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。关于使用APP认证的方法，具体请参考《开发指南》。 当选择“APP认证”时，需要配置“APP凭据”。 “APP凭据”：使用APP认证的API，需要在API网关中创建一个凭据，以生成凭据ID和密钥对（Key、Secret）。将创建的凭据绑定API后，才可以使用APP认证调用API。客户端（API调用者）在调用API过程中，把密钥对替换SDK中的密钥对，API网关服务根据密钥对进行身份核对，完成鉴权。具体创建凭据的步骤，请参考创建凭据 。
   华为IAM认证	表示借助IAM服务进行安全认证。 说明： 选择“华为IAM认证”时，任何API网关租户均可以访问此API，可能存在恶意刷流量，导致过量计费的风险。

编辑API

已发布的API，支持修改安全认证方式。

1. 进入KooSearch服务详情页面。
   1. 登录云搜索服务管理控制台。
   2. 在左侧导航栏选择“KooSearch>Flexus企业搜索服务”，进入KooSearch服务列表。
   3. 选择目标服务，单击服务名称，进入服务详情页。
2. 单击“API管理”，进入API管理页签。
3. 选择已发布的API，单击操作列的“编辑”。
4. 在“编辑”页面修改API的安全认证方式。
   • “APP认证”：表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。
     当选择“APP认证”时，需要配置“APP凭据”。

     • “APP凭据”：使用APP认证的API，需要在API网关中创建一个凭据，以生成凭据ID和密钥对（Key、Secret）。将创建的凭据绑定API后，才可以使用APP认证调用API。客户端（API调用者）在调用API过程中，把密钥对替换SDK中的密钥对，API网关服务根据密钥对进行身份核对，完成鉴权。具体创建凭据的步骤，请参考创建凭据 。
   • “华为IAM认证”：表示借助IAM服务进行安全认证。
     

     选择“华为IAM认证”时，任何API网关租户均可以访问此API，可能存在恶意刷流量，导致过量计费的风险。

5. 单击“确定”完成修改。

下线API

已发布的API因为其他原因需要暂停对外提供服务，可以暂时将API从相关环境中下线。

该操作将导致此API在指定的环境无法被访问，请确保已经告知使用此API的用户。

1. 进入KooSearch服务详情页面。
   1. 登录云搜索服务管理控制台。
   2. 在左侧导航栏选择“KooSearch>Flexus企业搜索服务”，进入KooSearch服务列表。
   3. 选择目标服务，单击服务名称，进入服务详情页。
2. 单击“API管理”，进入API管理页签。
3. 选择待下线的API，单击操作列的“下线”。
4. 在滑出的页面中选择下线API的“实例”、“下线环境”、“配置委托”后单击“确定”。
5. 待API的状态变为“未发布”，下线成功。