通过api使用koosearch实现搜索问答-j9九游会登录

场景描述

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>koosearch文档问答”，进入koosearch服务列表。
   3. 选择目标服务，单击服务名称，进入服务详情页。
2. 单击“api管理”，进入api管理页签。
3. 选择待发布的api，单击操作列的“发布”。
4. 在“发布”页面配置api网关信息。

   表1 发布服务

   参数	说明
   实例	使用api网关，需要先购买实例。可以单击右边的“实例管理”去创建实例。具体创建步骤请看创建实例。 说明： 实例需要跟koosearch服务在同一个vpc和子网。
   发布环境	api可以同时提供给不同的场景调用，如生产环境（release）及其他自定义环境。 建议选择默认存在的环境“release”，release是默认的线上环境，是正式发布api的环境，只有发布在release上的api，才能上架售卖。 如果您需要创建自定义环境，具体创建步骤请看创建环境。
   分组	api分组相当于api的集合，api提供者以api分组为单位，管理分组内的所有api。 建议选择默认分组“default”，该分组为系统自动生成，组内所有api均支持通过弹性公网ip（eip）或私有ip地址两种方式访问。 如果您需要创建自定义分组，具体创建步骤请看创建api分组。
   配置委托	选择iam委托，授权当前账号访问和使用apig的权限。 当首次配置委托时，可以单击“自动创建委托”新建委托“css_apig_agency”直接使用。 当已有自动创建的委托时，可以单击“委托一键授权”，自动删除委托中apig administrator系统角色或apig fullaccess系统策略的权限，并自动新增如下自定义策略授权委托到最小化权限。 "apig:vpcchannels:*", "apig:apis:*", "apig:instances:*", "apig:envs:*", "apig:groups:*", "apig:apps:*" 执行“自动创建委托”和“委托一键授权”的用户需要如下最小权限。 "iam:agencies:listagencies", "iam:roles:listroles", "iam:agencies:getagency", "iam:agencies:createagency", "iam:permissions:listrolesforagency", "iam:permissions:grantroletoagency", "iam:permissions:listrolesforagencyonproject", "iam:permissions:revokerolefromagency", "iam:roles:createrole" 使用委托的用户需要如下最小权限。 "iam:agencies:listagencies", "iam:agencies:getagency", "iam:permissions:listrolesforagencyonproject", "iam:permissions:listrolesforagency"
   安全认证	有app认证和iam认证两种方式，推荐使用app认证方式。 “app认证”：表示由api网关服务负责接口请求的安全认证。app认证方式具体有多种认证路径。推荐使用appcode简易认证。 使用appcode简易认证（推荐）：简易认证指在调用api时，http请求头部消息增加一个参数x-apig-appcode（参数值填凭据详情中“appcode”的值），而不需要对请求内容签名，api网关也仅校验appcode，不校验请求签名，从而实现快速响应。以下为操作步骤： 单击“凭据管理”，进入凭据管理页面。 图1 凭据管理 在“凭据管理”页面，单击“创建凭据”按钮，进入“创建凭据页面”，根据下面参数说明，填写凭据信息。 凭据名称：凭据的名称。支持英文、中文、数字、下划线，且只能以英文或中文开头，长度为3~64个字符。 描述：对凭据的介绍。长度为1~255个字符。 单击“确定”，创建凭据。 创建完成后单击创建好的凭据名称进入凭据详情页面。 单击“添加appcode”按钮。 生成方式选择“自动生成”，单击“确定”。 生成好的appcode出现在列表中。 appcode添加完成后，您可以使用appcode进行api请求的简易认证。 发送请求时，增加请求头部参数“x-apig-appcode”，省略请求签名相关信息。 以curl方式为例，增加头部参数名称：x-apig-appcode，参数值填已生成的appcode。 curl -x get "https://api.exampledemo.com/testapi" -h "content-type: application/json" -h "host: api.exampledemo.com" -h "x-apig-appcode: xhrjvjkabsoxc7d***********fzl4gshexkcmqc" 创建好凭据后，返回到发布页面，选择创建好的凭据，进行下一步操作。 使用密钥对（key、secret）认证。需要在api网关中创建一个凭据，以生成凭据id和密钥对，将创建的凭据绑定api后，才可以使用app认证调用api。客户端（api调用者）在调用api过程中，把密钥对替换sdk中的密钥对，api网关服务根据密钥对进行身份核对，完成鉴权。具体创建凭据的步骤，请参考配置apig的api认证凭据。 “华为iam认证”：表示借助iam服务进行安全认证。 说明： 选择“华为iam认证”时，任何api网关租户均可以访问此api，可能存在恶意刷流量，导致过量计费的风险。

5. 单击“确定”。

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

调用已发布的koosearch api

在业务环境中调用已发布的koosearch api。

具体操作请参见《koosearch api参考》。

编辑api

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

1. 进入koosearch服务详情页面。
   1. 登录。
   2. 在左侧导航栏选择“koosearch>koosearch文档问答”，进入koosearch服务列表。
   3. 选择目标服务，单击服务名称，进入服务详情页。
2. 单击“api管理”，进入api管理页签。
3. 选择已发布的api，单击操作列的“编辑”。
4. 在“编辑”页面修改api的安全认证方式。
   • “华为iam认证”：表示借助iam服务进行安全认证。
     

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

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

下线api

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

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

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