簡單體育統計 - ChatGPT聊天插件案例

By James Qi, 2023年9月21日
簡單體育統計 - ChatGPT聊天插件案例

學習如何構建一個簡單的體育統計插件。

此插件是一個簡單的體育統計API的示例。在考慮構建内容時，請記住我們的域名政策和使用政策。

首先，定義一個ai-plugin.json文件，包含以下字段：

```json 
{ 
   "schema_version": "v1", 
   "name_for_human": "體育統計", 
   "name_for_model": "sportStats", 
   "description_for_human": "獲取運動員和比賽的當前和曆史統計數據。", 
   "description_for_model": "獲取運動員和比賽的當前和曆史統計數據。始終使用markdown表格顯示結果。", 
   "auth": { 
       "type": "none" 
   }, 
   "api": { 
       "type": "openapi", 
       "url": "PLUGIN_HOSTNAME/openapi.yaml" 
   }, 
   "logo_url": "PLUGIN_HOSTNAME/logo.png", 
   "contact_email": "support@example.com", 
   "legal_info_url": "https://example.com/legal" 
} 
```

注意，PLUGIN_HOSTNAME應該是您的插件服務器的實際主機名。

接下來，我們為一個簡單的體育服務插件定義一個模拟API。

```python 
import json 
import requests 
import urllib.parse

import quart 
import quart_cors 
from quart import request

# 注意：隻有在運行本地主機插件時才需要設置CORS以允許chat.openapi.com 
app = quart_cors.cors(quart.Quart(__name__), allow_origin="https://chat.openai.com") 
HOST_URL = "https://example.com"

@app.get("/players") 
async def get_players(): 
   query = request.args.get("query") 
   res = requests.get( 
       f"{HOST_URL}/api/v1/players?search={query}&page=0&per_page=100") 
   body = res.json() 
   return quart.Response(response=json.dumps(body), status=200)


@app.get("/teams") 
async def get_teams(): 
   res = requests.get( 
       "{HOST_URL}/api/v1/teams?page=0&per_page=100") 
   body = res.json() 
   return quart.Response(response=json.dumps(body), status=200)


@app.get("/games") 
async def get_games(): 
   query_params = [("page", "0")] 
   limit = request.args.get("limit") 
   query_params.append(("per_page", limit or "100")) 
   start_date = request.args.get("start_date") 
   if start_date: 
       query_params.append(("start_date", start_date)) 
   end_date = request.args.get("end_date")

   if end_date: 
       query_params.append(("end_date", end_date)) 
   seasons = request.args.getlist("seasons")

   for season in seasons: 
       query_params.append(("seasons[]", str(season))) 
   team_ids = request.args.getlist("team_ids")

   for team_id in team_ids: 
       query_params.append(("team_ids[]", str(team_id)))

   res = requests.get( 
       f"{HOST_URL}/api/v1/games?{urllib.parse.urlencode(query_params)}") 
   body = res.json() 
   return quart.Response(response=json.dumps(body), status=200)


@app.get("/stats") 
async def get_stats(): 
   query_params = [("page", "0")] 
   limit = request.args.get("limit") 
   query_params.append(("per_page", limit or "100")) 
   start_date = request.args.get("start_date") 
   if start_date: 
       query_params.append(("start_date", start_date)) 
   end_date = request.args.get("end_date")

   if end_date: 
       query_params.append(("end_date", end_date)) 
   player_ids = request.args.getlist("player_ids")

   for player_id in player_ids: 
       query_params.append(("player_ids[]", str(player_id))) 
   game_ids = request.args.getlist("game_ids")

   for game_id in game_ids: 
       query_params.append(("game_ids[]", str(game_id))) 
   res = requests.get( 
       f"{HOST_URL}/api/v1/stats?{urllib.parse.urlencode(query_params)}") 
   body = res.json() 
   return quart.Response(response=json.dumps(body), status=200)


@app.get("/season_averages") 
async def get_season_averages(): 
   query_params = [] 
   season = request.args.get("season") 
   if season: 
       query_params.append(("season", str(season))) 
   player_ids = request.args.getlist("player_ids")

   for player_id in player_ids: 
       query_params.append(("player_ids[]", str(player_id))) 
   res = requests.get( 
       f"{HOST_URL}/api/v1/season_averages?{urllib.parse.urlencode(query_params)}") 
   body = res.json() 
   return quart.Response(response=json.dumps(body), status=200)


@app.get("/logo.png") 
async def plugin_logo(): 
   filename = 'logo.png' 
   return await quart.send_file(filename, mimetype='image/png')


@app.get("/.well-known/ai-plugin.json") 
async def plugin_manifest(): 
   host = request.headers['Host'] 
   with open("ai-plugin.json") as f: 
       text = f.read() 
       # This is a trick we do to populate the PLUGIN_HOSTNAME constant in the manifest 
       text = text.replace("PLUGIN_HOSTNAME", f"https://{host}") 
       return quart.Response(text, mimetype="text/json")


@app.get("/openapi.yaml") 
async def openapi_spec(): 
   host = request.headers['Host'] 
   with open("openapi.yaml") as f: 
       text = f.read() 
       # This is a trick we do to populate the PLUGIN_HOSTNAME constant in the OpenAPI spec 
       text = text.replace("PLUGIN_HOSTNAME", f"https://{host}") 
       return quart.Response(text, mimetype="text/yaml")


def main(): 
   app.run(debug=True, host="0.0.0.0", port=5001)


if __name__ == "__main__": 
   main() 
```

最後，我們定義我們的OpenAPI規範：

openapi: 3.0.1 
info: 
   title: Sport Stats 
   description: Get current and historical stats for sport players and games. 
   version: "v1" 
servers: 
   - url: PLUGIN_HOSTNAME 
paths: 
   /players: 
       get: 
           operationId: getPlayers 
           summary: Retrieves all players from all seasons whose names match the query string. 
           parameters: 
               - in: query 
                 name: query 
                 schema: 
                     type: string 
                 description: Used to filter players based on their name. For example, ?query=davis will return players that have 'davis' in their first or last name. 
           responses: 
               "200": 
                   description: OK 
   /teams: 
       get: 
           operationId: getTeams 
           summary: Retrieves all teams for the current season. 
           responses: 
               "200": 
                   description: OK 
   /games: 
       get: 
           operationId: getGames 
           summary: Retrieves all games that match the filters specified by the args. Display results using markdown tables. 
           parameters: 
               - in: query 
                 name: limit 
                 schema: 
                     type: string 
                 description: The max number of results to return. 
               - in: query 
                 name: seasons 
                 schema: 
                     type: array 
                     items: 
                         type: string 
                 description: Filter by seasons. Seasons are represented by the year they began. For example, 2018 represents season 2018-2019. 
               - in: query 
                 name: team_ids 
                 schema: 
                     type: array 
                     items: 
                         type: string 
                 description: Filter by team ids. Team ids can be determined using the getTeams function. 
               - in: query 
                 name: start_date 
                 schema: 
                     type: string 
                 description: A single date in 'YYYY-MM-DD' format. This is used to select games that occur on or after this date. 
               - in: query 
                 name: end_date 
                 schema: 
                     type: string 
                 description: A single date in 'YYYY-MM-DD' format. This is used to select games that occur on or before this date. 
           responses: 
               "200": 
                   description: OK 
   /stats: 
       get: 
           operationId: getStats 
           summary: Retrieves stats that match the filters specified by the args. Display results using markdown tables. 
           parameters: 
               - in: query 
                 name: limit 
                 schema: 
                     type: string 
                 description: The max number of results to return. 
               - in: query 
                 name: player_ids 
                 schema: 
                     type: array 
                     items: 
                         type: string 
                 description: Filter by player ids. Player ids can be determined using the getPlayers function. 
               - in: query 
                 name: game_ids 
                 schema: 
                     type: array 
                     items: 
                         type: string 
                 description: Filter by game ids. Game ids can be determined using the getGames function. 
               - in: query 
                 name: start_date 
                 schema: 
                     type: string 
                 description: A single date in 'YYYY-MM-DD' format. This is used to select games that occur on or after this date. 
               - in: query 
                 name: end_date 
                 schema: 
                     type: string 
                 description: A single date in 'YYYY-MM-DD' format. This is used to select games that occur on or before this date. 
           responses: 
               "200": 
                   description: OK 
   /season_averages: 
       get: 
           operationId: getSeasonAverages 
           summary: Retrieves regular season averages for the given players. Display results using markdown tables. 
           parameters: 
               - in: query 
                 name: season 
                 schema: 
                     type: string 
                 description: Defaults to the current season. A season is represented by the year it began. For example, 2018 represents season 2018-2019. 
               - in: query 
                 name: player_ids 
                 schema: 
                     type: array 
                     items: 
                         type: string 
                 description: Filter by player ids. Player ids can be determined using the getPlayers function. 
           responses: 
               "200": 
                   description: OK

评论

關於文字格式

Plain text

  • 不允許使用 HTML 標籤。
  • 網頁和電子郵件地址自動轉換為連結。
  • 自動斷行和分段。
CAPTCHA
此问题用于测试您是否是人类访问者并防止自动提交垃圾信息。

Chatbot

2002-2023 v11.7 a-j-e-0