From 88da7aa76145b9dd01e9d26f60afeebd3bc1ec5f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=8E=98=E6=9D=83=20=E9=A9=AC?= <mashenquan@fuzhi.ai>
Date: Sun, 20 Aug 2023 19:23:05 +0800
Subject: [PATCH] feat: +skill meta data decorator

---
 metagpt/learn/skill_metadata.py    | 25 +++++++++++++++++++++++++
 metagpt/learn/text_to_embedding.py |  4 ++++
 metagpt/learn/text_to_image.py     |  4 ++++
 metagpt/learn/text_to_speech.py    |  4 ++++
 4 files changed, 37 insertions(+)
 create mode 100644 metagpt/learn/skill_metadata.py

diff --git a/metagpt/learn/skill_metadata.py b/metagpt/learn/skill_metadata.py
new file mode 100644
index 000000000..6a13d6274
--- /dev/null
+++ b/metagpt/learn/skill_metadata.py
@@ -0,0 +1,25 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+@Time    : 2023/8/20
+@Author  : mashenquan
+@File    : skill_metadata.py
+@Desc    : Defines metadata for the `skill`.
+        Depending on the context and specific circumstances, skills may have different effects.
+        For example:
+            Proprietor: "Skill of the proprietor entity."（所有者的技能）
+            Holder: "Skill of the holder entity."（持有者的技能）
+            Possessor: "Skill of the possessor entity."（拥有者的技能）
+            Controller: "Skill of the controller entity."（控制者的技能）
+            Owner: "Skill of the owner entity."（所有者的技能）
+"""
+
+
+def skill_metadata(name, description, requisite):
+    def decorator(func):
+        func.skill_name = name
+        func.skill_description = description
+        func.skill_requisite = requisite
+        return func
+
+    return decorator
diff --git a/metagpt/learn/text_to_embedding.py b/metagpt/learn/text_to_embedding.py
index 281815ca6..38fd7c0cb 100644
--- a/metagpt/learn/text_to_embedding.py
+++ b/metagpt/learn/text_to_embedding.py
@@ -8,10 +8,14 @@
 """
 import os
 
+from metagpt.learn.skill_metadata import skill_metadata
 from metagpt.tools.openai_text_to_embedding import oas3_openai_text_to_embedding
 from metagpt.utils.common import initialize_environment
 
 
+@skill_metadata(name="Text to Embedding",
+                description="Convert the text into embeddings.",
+                requisite="`OPENAI_API_KEY`")
 def text_to_embedding(text, model="text-embedding-ada-002", openai_api_key=""):
     """Text to embedding
 
diff --git a/metagpt/learn/text_to_image.py b/metagpt/learn/text_to_image.py
index 0932dfe07..d123e116a 100644
--- a/metagpt/learn/text_to_image.py
+++ b/metagpt/learn/text_to_image.py
@@ -8,11 +8,15 @@
 """
 import os
 
+from metagpt.learn.skill_metadata import skill_metadata
 from metagpt.tools.metagpt_text_to_image import oas3_metagpt_text_to_image
 from metagpt.tools.openai_text_to_image import oas3_openai_text_to_image
 from metagpt.utils.common import initialize_environment
 
 
+@skill_metadata(name="Text to image",
+                description="Create a drawing based on the text.",
+                requisite="`OPENAI_API_KEY` or `METAGPT_TEXT_TO_IMAGE_MODEL`")
 def text_to_image(text, size_type: str = "512x512", openai_api_key="", model_url=""):
     """Text to image
 
diff --git a/metagpt/learn/text_to_speech.py b/metagpt/learn/text_to_speech.py
index 1b81097b8..5631ef45e 100644
--- a/metagpt/learn/text_to_speech.py
+++ b/metagpt/learn/text_to_speech.py
@@ -8,10 +8,14 @@
 """
 import os
 
+from metagpt.learn.skill_metadata import skill_metadata
 from metagpt.tools.azure_tts import oas3_azsure_tts
 from metagpt.utils.common import initialize_environment
 
 
+@skill_metadata(name="Text to speech",
+                description="Text-to-speech",
+                requisite="`AZURE_TTS_SUBSCRIPTION_KEY` and `AZURE_TTS_REGION`")
 def text_to_speech(text, lang="zh-CN", voice="zh-CN-XiaomoNeural", style="affectionate", role="Girl",
                    subscription_key="", region=""):
     """Text to speech