For the complete documentation index, see llms.txt. This page is also available as Markdown.
Định dạng JSON cho Công cụ Thông minh
Một cách di động để chia sẻ các công cụ thông minh SkyDeck.AI được viết bằng mã Python
Tổng quan
Để tạo một công cụ thông minh trên SkyDeck.AI, bạn cần tải lên một bộ tệp theo các thông số kỹ thuật được đề cập trong phần Cấu trúc Tệp. Sau khi tải lên, nền tảng của chúng tôi sẽ thực hiện thiết lập ban đầu, có thể mất vài phút. Sau đó, công cụ sẽ có sẵn trong Không gian GenStudio.
Cấu trúc Tệp
<tool_name>.json
Hành vi của công cụ cũng được cấu hình thông qua một tệp JSON. Dưới đây là cái nhìn tổng quan ngắn gọn về các trường chính trong cấu hình:
version: Phiên bản hiện tại của công cụ.
tool_name: Tên của công cụ. Tên này nên là duy nhất trong không gian làm việc của bạn.
tool_code: Chứa mã Python sẽ được thực thi. Thông tin chi tiết về trường này sẽ có ở phần tiếp theo.
description: Mô tả ngắn gọn về những gì công cụ thực hiện.
usage_notes: Hướng dẫn cách sử dụng công cụ.
model_version: Chỉ định các mô hình được phép sử dụng cho các câu hỏi tiếp theo. Để chỉ định tất cả các mô hình, sử dụng ["gpt-4", "gpt-3.5", "claude", "chat-bison"].
creator: Thông tin về người tạo công cụ, bao gồm tên, email và tổ chức.
variables: Một mảng các biến được công cụ sử dụng. Mỗi biến có một tên, mô tả và giá trị mặc định. Thứ tự của các biến trong giao diện người dùng theo thứ tự trong mảng này.
expected_output: Loại đầu ra được tạo ra bởi công cụ. Trong giai đoạn phát triển, giá trị này luôn nên là văn bản.
avatar_type: Định dạng của avatar được sử dụng trong giao diện người dùng của công cụ.
timestamp: Ngày và giờ khi công cụ được cập nhật lần cuối.
requirements: chỉ định các gói cần thiết để chạy tập lệnh trong tool_code.
avatar: chuỗi đại diện cho logo của công cụ này
quy ước tool_code:
Kịch bản này phác thảo cách hoạt động của công cụ của bạn. Thành phần chính của kịch bản này là hàm execute, có các yêu cầu sau:
Hàm này nên có một tham số đầu vào duy nhất gọi là variables, là một từ điển. Mỗi khóa trong từ điển này tương ứng với một trường mà người dùng sẽ nhập vào công cụ của bạn.
Hàm này nên trả về một chuỗi, sẽ được hiển thị như là phản hồi trên giao diện GenStudio.
Ví dụ Công Cụ
Tạo hình ảnh bằng DALL-E 2
Mô tả:
Công cụ này chấp nhận một mô tả hình ảnh làm đầu vào và tạo ra một URL tương ứng cho hình ảnh. Đầu ra bao gồm URL cùng với một ghi chú hết hạn. Công cụ hoạt động bằng cách gửi truy vấn đến API DALL-E của OpenAI và lấy phản hồi.
Đầu vào:
Mô tả: Mô tả hình ảnh, ví dụ, "Một con mèo lông trắng"
Đầu ra:
Một thông điệp với URL được tạo ra cho hình ảnh cùng với ghi chú hết hạn.
Kịch bản Python (sẽ là một trường bên trong image_generation.json):
image_generation.json
Báo cáo thời tiết theo thời gian thực với Open-Meteo API
Mô tả:
Công cụ này tận dụng Open-Meteo API để cung cấp thông tin thời tiết theo thời gian thực dựa trên các câu hỏi của người dùng. Bằng cách đặt câu hỏi về thời tiết, chẳng hạn như nhiệt độ, lượng mưa hoặc điều kiện gió, công cụ sẽ truy xuất dữ liệu liên quan và cập nhật nhất.
Chức năng của công cụ này dựa vào APIChain - một tính năng từ thư viện LangChain - để truy cập tài liệu Open-Meteo API. Điều này cho phép công cụ học cách thực hiện các cuộc gọi API chính xác và truy xuất thông tin cần thiết một cách liền mạch.
Đầu vào:
Câu hỏi: Đặt một câu hỏi cụ thể về thời tiết, ví dụ: "Nhiệt độ hiện tại ở New York City là bao nhiêu?"
Đầu ra:
Một phản hồi cung cấp thông tin thời tiết theo yêu cầu.
Mã Python (sẽ là một trường bên trong weather_reporter.json):
import openai
def execute(variables):
openai.api_key = '<USER API KEY>'
description = variables['Mô tả']
response = openai.Image.create(
prompt=description,
n=1,
size="1024x1024"
)
image_url = response['data'][0]['url']
return f"Đây là liên kết đến hình ảnh của bạn:{image_url}. Liên kết sẽ hết hạn trong 1 giờ."
{
"version": "0.1",
"metadata": {
"tool_name": "Tạo hình ảnh",
"tool_code": "import openai\n\ndef execute(variables):\n openai.api_key = ''\n description = variables['Description']\n response = openai.Image.create(\n prompt=description,\n n=1,\n size=\"1024x1024\"\n )\n\n image_url = response['data'][0]['url']\n return f\"Đây là liên kết đến hình ảnh của bạn:{image_url}. Liên kết sẽ hết hạn trong 1 giờ.\"\n",
"description": "Tạo ra một hình ảnh dựa trên mô tả với mô hình DALL-E của OpenAI.",
"usage_notes": "Mô tả hình ảnh một cách chi tiết và đưa vào trường mô tả. Một URL của hình ảnh sẽ được trả về. Thời gian sống của URL khoảng 1 giờ, vì vậy hãy chắc chắn tải xuống trước khi hết hạn.",
"model_version": ["gpt-3.5","gpt-3.5-turbo", "gpt-4", "claude"],
"creator": {
"name": "SkyDeck AI",
"email": "skydeck@eastagile.com",
"organization": "East Agile"
},
"variables": [
{
"name": "Description",
"description": "Mô tả hình ảnh",
"default": "một con mèo siames trắng"
}
],
"expected_output": {
"type": "text"
},
"avatar_type": "base64",
"timestamp": "2023-05-23T10:00:00Z",
"requirements": "openai>=0.27.4",
"avatar": ""
}
}
from langchain.chains.api import open_meteo_docs
from langchain.chat_models import ChatOpenAI
from langchain.chains import APIChain
def execute(variables):
question = variables['Question']
llm = ChatOpenAI(
model_name='gpt-3.5-turbo',
openai_api_key='<USER API KEY>'
)
api_chain = APIChain.from_llm_and_api_docs(
llm, open_meteo_docs.OPEN_METEO_DOCS, verbose=False
)
result = api_chain.run(question)
return result
{
"version": "0.1",
"metadata": {
"tool_name": "Weather Reporter",
"tool_code": "from langchain.chains.api import open_meteo_docs\nfrom langchain.chat_models import ChatOpenAI\nfrom langchain.chains import APIChain\n\n\ndef execute(variables):\n question = variables['Question']\n llm = ChatOpenAI(model_name='gpt-3.5-turbo',\n openai_api_key='')\n api_chain = APIChain.from_llm_and_api_docs(\n llm, open_meteo_docs.OPEN_METEO_DOCS, verbose=False)\n result = api_chain.run(question)\n return result\n",
"description": "Sử dụng API Open-Meteo để lấy thông tin thời tiết theo thời gian thực",
"usage_notes": "Nhập câu hỏi liên quan đến thời tiết của bạn vào trường được cung cấp",
"model_version": ["gpt-3.5", "gpt-3.5-turbo", "gpt-4", "claude"],
"creator": {
"name": "SkyDeck AI",
"email": "skydeck@eastagile.com",
"organization": "East Agile"
},
"variables": [
{
"name": "Question",
"description": "Hỏi về điều kiện thời tiết",
"default": "Nhiệt độ hiện tại ở Munich, Đức là bao nhiêu độ C?"
}
],
"expected_output": {
"type": "text"
},
"avatar_type": "base64",
"timestamp": "2023-07-13T10:00:00Z",
"requirements": "openai>=0.27.4\nlangchain>=0.0.229",
"avatar": ""
}
}
