ModelScope创空间-通过OpenAPI创建工具

最新推荐文章于 2025-05-20 22:36:56 发布

QQ92058858

最新推荐文章于 2025-05-20 22:36:56 发布

阅读量416

点赞数 6

文章标签：运维

本文链接：https://blog.csdn.net/2509_92058858/article/details/148054821

版权

OpenAPI类工具的创建#

依次点击创建新工具、通过OpenAPI创建，进入OpenAPI类工具的创建流程。在本文档中，您可以一步步依照后文指引，创建一个查询IP地理位置信息的工具。

alt text

基本信息#

中英文名称、封面、开源证书、标签等信息，请按实际情况填写。

在本样例中，我们创建的是查询IP地理位置信息的工具，可以填写英文名为ip_info_api。

工具描述#

请介绍该工具的功能，以便用户能在调用的时候能够快速了解该工具的功能以及参数，也可附上作为开发者的信息，可以参考如下的格式进行编写。

在本样例中，您可以按如下填写：

用于查询IP地址的地理位置信息的工具。
输入要查询的IP地址，获取IP的地理位置、组织等信息。

输入信息：IP地址，如`59.82.43.239`

输出样例：
包含城市、时区、组织等信息。
{
    "city": "Shanghai",
    "country": "CN",
    "ip": "59.82.43.239",
    "loc": "31.2222,121.4581",
    "org": "AS37963 Hangzhou Alibaba Advertising Co.,Ltd.",
    "postal": "200000",
    "readme": "https://ipinfo.io/missingauth",
    "region": "Shanghai",
    "timezone": "Asia/Shanghai"
}

鉴权信息填写#

您可以选择无鉴权信息(None)或者API key方式鉴权。若选择API key方式鉴权，大模型调用插件时，会在HTTP请求的header中传入相应的鉴权信息。

在本样例中，无需配置鉴权信息。

Schema填写#

在本样例中，Schema如下：

openapi: 3.0.0
info:
  title: IPInfo API
  version: 1.0.0
  description: 用于查询IP地址的地理位置信息的API
servers:
  - url: http://ipinfo.io
paths:
  /{ip}:
    get:
      summary: 获取IP信息
      description: 检索指定IP地址的地理位置和其他信息。
      parameters:
        - name: ip
          in: path
          required: true
          description: 要查询的IP地址。
          schema:
            type: string
      responses:
        '200':
          description: 成功返回IP信息
          content:
            application/json:
              schema:
                type: object
                properties:
                  ip:
                    type: string
                    description: IP地址。
                  city:
                    type: string
                    description: 与IP地址相关联的城市。
                  region:
                    type: string
                    description: 与IP地址相关联的地区。
                  country:
                    type: string
                    description: 与IP地址相关联的国家。
                  loc:
                    type: string
                    description: IP地址位置的经纬度。
                  org:
                    type: string
                    description: 与IP地址相关联的组织。
                  postal:
                    type: string
                    description: IP地址位置的邮政编码。
                  timezone:
                    type: string
                    description: IP地址位置的时区。
                  readme:
                    type: string
                    description: 指向自述文件或更多信息的URL。

关键字段解读：

servers：定义了调用的API地址，请确保服务运行正常。
paths：Schema可以被解析为多个工具。每个工具对应一个特定方法（GET/POST/PUT/DELETE）的path。
- description：工具在被大模型调用的时候，不同的工具对应的description必须要描述清晰，以便大模型能够正确的使用该工具。
- parameters定义了请求接口的IP参数的填写规范。in: path说明在path中，required指明这个参数是必须的参数，description指导大模型这个参数的内容，type: string指明这个参数是个字符串。