# 调用搜索规划大模型
搜索规划属于预置模型，模型部署成功后，可以使用API实现模型调用。
 表1搜索规划大模型API清单 
| API分类       | API访问后缀路径（URI）          |
|:---|:---|
| search_plan | /app/search/v1/planning |
   
 #### 获取调用路径
1. 登录ModelArts Studio大模型开发平台，在"我的空间"模块，单击进入所需空间。
   图1我的空间   
   ![](https://support.huaweicloud.com/usermanual-pangulm/zh-cn_image_0000002601726015.png) 
2. URI获取步骤如下：
   1. 登录ModelArts Studio大模型开发平台。
   
   2. 进入所需工作空间。
   
   3. 获取请求URI。
      - 获取模型请求URI。 若调用部署后的模型，可在左侧导航栏中选择"模型开发 \> 模型部署"，在"我的服务"页签，模型部署列表单击模型名称，在"详情"页签中，可获取模型的请求URI。
        
      
      - 与[表1]里的后缀进行拼接，获取最终的API请求路径如[表2]。
         表2API访问路径 
        | API分类       | API访问路径（URI）                                                                                                 |
        |:---|:---|
        | search_plan | https://xxx.myhuaweicloud.com/v1/{project_id}/infer-api/proxy/service/{deployment_id}/app/search/v1/planning |
           
        
       
    
 
#### 使用Postman调用API
1. 在Postman中新建POST请求，并填入模型调用路径，详见[获取调用路径]。
2. 调用API有两种认证方式，包括Token认证和API Key认证。其中，[API Key认证]的使用场景为当用户部署的API服务期望开放给其他用户调用时，原有Token认证无法支持，可通过API Key认证调用请求。
   参考[表3]填写请求Header参数。
    表3请求Header参数填写说明 
   | 认证方式            | 参数名            | 参数值                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
   |:---|:---|:---|
   | Token认证         | Content-Type   | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
   | Token认证         | X-Auth-Token   | Token值，参考《API参考》文档"如何调用REST API \> 认证鉴权 \> Token认证"章节获取Token。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
   | V1推理接口API Key认证 | Content-Type   | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
   | V1推理接口API Key认证 | X-Apig-AppCode | API Key值，获取API Key步骤如下： 1. 登录ModelArts Studio平台，进入所需空间。  2. 在左侧导航栏中选择"系统管理与统计 \> 应用接入"，单击界面右上角"创建应用接入"。  3. 在"应用配置"中，选择已部署好的大模型，单击"确定"。  4. 在"应用接入"列表的"API Key"操作列中可获取API Key值。   |
      
   如[图2]，为Token认证方式的请求Header参数填写示例。
   图2配置请求参数   
   ![](https://support.huaweicloud.com/usermanual-pangulm/zh-cn_image_0000002601726013.png) 
3. 在Postman中选择"Body \> raw"选项，参考以下代码填写请求Body。 search_plan接口body样例：
   ```
   {
       "query": "今天天气怎样？" ,
       "history": []
   }
   ```
   
4. 单击Postman界面"Send"，发送请求。当接口返回状态码为200时，表示搜索规划大模型API调用成功。
 
 #### API Key鉴权说明
当用户部署的API服务期望开放给其他用户调用时，原有Token认证无法支持，
可用API Key认证的鉴权方式进行调用请求。
API Key认证指调用API时，在HTTP请求头部消息增加一个参数X-Apig-AppCode（参数值为API Key值），API服务仅校验API Key，从而实现快速响应。
使用该鉴权方式前，请确保有已部署的大模型。
**获取API Key步骤如下：**
1. 登录ModelArts Studio平台，进入所需空间。
2. 在左侧导航栏中选择"系统管理与统计 \> 应用接入"，单击界面右上角"创建应用接入"。
3. 在"应用配置"中，选择已部署好的大模型，并设置应用接入名称、描述，单击"确定"。
4. 在"应用接入"列表的"API Key"列中可获取API Key值。