文心一言插件开发（第三篇

目录

1. 从0到1开发自己的插件：

1.1 插件描述文件（ai-plugin.json）

一个插件需要一份ai-plugin.json命名的manifest文件，用于描述插件的基本信息

ai-plugin.json 文件总长度建议不超过 1500 字符

举例：

{
    "schema_version": "v1",
    "name_for_human": "单词本_TianJi",
    "name_for_model": "wordbook_TianJi",
    "description_for_human": "个性化的英文单词本，可以增加、删除和浏览单词本中的单词，并可以按要求从单词本中随机抽取单词生成句子或段落",
    "description_for_model": "帮助用户管理单词本，可以增加、删除、浏览单词本，背单词时可以指定随机抽取单词本中若干个单词，生成句子会段落",
    "auth": {
        "type": "none"
    },
    "api":{
        "type": "openapi",
        "url": "http://127.0.0.1:8081/.well-known/openapi.yaml"
    },
    "logo_url": "https://img-blog.csdnimg.cn/direct/69935055b23f4362b4747c1e6b5534e0.png",
    "contact_email": "support@example.com",
    "legal_info_url": "http://www.example.com/legal"
}

插件图像：

只要删除插件再重新提交或者更新配置即可，url是http://127.0.0.1:8081/.well-known/openapi.yaml，只需要填http://127.0.0.1:8081即可，效果：

1.2 服务描述文件（openapi.yaml）

YAML 文件总长度，不可超过 1000个字符 (不包含空格)

APIs定义描述文件需要满足OpenAPI标准，详细见：OpenAPI 规范
OpenAPI 规范 （OAS） 定义了一个标准的、与语言无关的 HTTP API 接口，它允许人类和计算机发现和理解服务的功能，而无需访问源代码、文档或通过网络流量检查。正确定义后，使用者可以使用最少的实现逻辑来理解远程服务并与之交互。

1.2.1 数据类型：

支持 Markdown 格式

1.2.1 OpenAPI 对象：

示例：

title: Sample Pet Store App
summary: A pet store manager.
description: This is a sample server for a pet store.
termsOfService: https://example.com/terms/
contact:
  name: API Support
  url: https://www.example.com/support
  email: support@example.com
license:
  name: Apache 2.0
  url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.1

1.3 示例描述文件（example.yaml 可选）

example机制可帮助开发者提供示例，提升插件调用的正确率
为了保障模型触发的效果，每个example.yaml 包含若干示例，文件的长度建议不超过 300 个字符

1.4 开发自己的plugin-server

注意：为了给用户提供更好的体验，插件服务有超时要求：0.5s连接超时，3s读超时，2s读响应头超时，如果插件服务内部处理流程较长，建议采用sse流式方式及时返回，可以参考 5.2 插件为用户显示执行动作。

根据信息中描述的api定义开发自己的服务接口，并在服务中定义自己的插件能力。如下是一个python的示例，您也可以使用其他开发语言进行 server 开发

@app.route() -> Python 中的装饰器

例如：

#!/usr/env python3
# -*- coding: UTF-8 -*-

from flask import Flask, request, make_response
import json
import random

app = Flask(__name__)  # 创建一个Flask应用程序实例
CORS(app, resources={r"/*": {"origins": "https://yiyan.baidu.com"}})  # 允许跨域请求
wordbook = []  # 初始化一个空的单词本列表


def make_json_response(data, status_code=200):
    """
    生成 JSON 格式的响应
    """
    response = make_response(json.dumps(data), status_code)
    response.headers["Content-Type"] = "application/json"
    return response


@app.route("/add_word", methods=['POST'])
async def add_word():
    """
    添加一个单词
    """
    word = request.json.get('word', "")  # 从请求中获取要添加的单词
    wordbook.append(word)  # 将单词添加到单词本列表中
    return make_json_response({"message": "单词添加成功"})  # 返回添加成功的消息


@app.route("/delete_word", methods=['DELETE'])
async def delete_word():
    """
    删除一个单词
    """
    word = request.json.get('word', "")  # 从请求中获取要删除的单词
    if word in wordbook:
        wordbook.remove(word)  # 如果单词存在于单词本中，则将其删除
    return make_json_response({"message": "单词删除成功"})  # 返回删除成功的消息


@app.route("/get_wordbook")
async def get_wordbook():
    """
    获得单词本
    """
    return make_json_response({"wordbook": wordbook})  # 返回当前的单词本列表


@app.route("/generate_sentences", methods=['POST'])
async def generate_sentences():
    """
    生成句子
    """
    number = request.get_json()['word_number']  # 从请求中获取要生成句子的单词数量
    number = min(number, len(wordbook))  # 确保要生成的单词数量不超过单词本的长度
    random_words = random.sample(wordbook, number)  # 从单词本中随机选取指定数量的单词
    prompt = "利用英文单词（words）生成一个英文段落，要求这个段落不超过100个英文单词且必须全英文，" \
             "并包含上述英文单词，同时是一个有逻辑的句子"
    # API返回字段"prompt"有特殊含义：开发者可以通过调试它来调试输出效果
    return make_json_response({"words": random_words, "prompt": prompt})  # 返回随机单词列表和提示语句


if __name__ == '__main__':
    app.run(debug=True, host='0.0.0.0', port=8081)  # 如果是直接运行这个文件，则启动Flask应用，监听8081端口

小结：

关注我给大家分享更多有趣的知识，以下是个人公众号，提供 ||代码兼职|| ||代码问题求解||
由于本号流量还不足以发表推广，搜我的公众号即可：