Promptをフォーマットする
PromptFormatter¶
PromptoGenでは、プロンプトを文字列にするためのフォーマッターを柔軟に作成できます。
PromptFormatter を理解するために、 Valueをフォーマットする と Valueをパースする を参照してください。
プロンプトを入力パラメータなしで文字列にフォーマットする¶
このページで使用する summarizer という名前のプロンプトは Promptの例 で作成したものです。
入力パラメータなしで文字列にフォーマットするには、フォーマッターの format_prompt_without_input メソッドを使用します。
このメソッドは、プロンプトとフォーマッターを引数に取り、プロンプトを文字列にフォーマットします。
例: KeyValuePromptFormatter¶
KeyValuePromptFormatter というフォーマッターを使用します。
このフォーマッターは、入出力変数のキーとバリューを key: value の形式で出力します。
- 入力パラメータは
KeyValueFormatterを使用してフォーマットされます。 - 出力パラメータは
KeyValueFormatterを使用してフォーマットされます。
コンソール出力:
Summarize text and extract keywords.
Input Parameters:
- text: Text to summarize
Output Parameters:
- summary: Summary of text
- keywords: Keywords extracted from text
Template:
Input:
text: "This is a sample text to summarize."
Output:
summary: """This is a summary of the text."""
keywords: [
"sample",
"text",
"summarize"
]
Example 1:
Input:
text: "One sunny afternoon, a group of friends decided to gather at the nearby park to engage in various games and activities. They played soccer, badminton, and basketball, laughing and enjoying each other's company while creating unforgettable memories together."
Output:
summary: """A group of friends enjoyed an afternoon playing sports and making memories at a local park."""
keywords: [
"friends",
"park",
"sports",
"memories"
]
例: JsonPromptFormatter¶
JsonPromptFormatter というフォーマッターを使用します。
このフォーマッターは、入出力変数のキーとバリューをJSON形式で出力します。
Summarize text and extract keywords.
Output a JSON-formatted string without outputting any other strings.
Be careful with the order of brackets in the json.
Input Parameters:
- text: Text to summarize
Output Parameters:
- summary: Summary of text
- keywords: Keywords extracted from text
Template:
Input:
```json
{
"text": "This is a sample text to summarize."
}```
Output:
```json
{
"summary": "This is a summary of the text.",
"keywords": [
"sample",
"text",
"summarize"
]
}```
Example 1:
Input:
```json
{
"text": "One sunny afternoon, a group of friends decided to gather at the nearby park to engage in various games and activities. They played soccer, badminton, and basketball, laughing and enjoying each other's company while creating unforgettable memories together."
}```
Output:
```json
{
"summary": "A group of friends enjoyed an afternoon playing sports and making memories at a local park.",
"keywords": [
"friends",
"park",
"sports",
"memories"
]
}```
例: カスタムフォーマッター¶
PromptFormatter に入力フォーマッターと出力フォーマッターを指定することで、カスタムフォーマッターを作成できます。
この例では、KeyValueFormatter を入力フォーマッターとして、JsonValueFormatter を出力フォーマッターとして使用します。
from promptogen.prompt_formatter import KeyValueFormatter, JsonValueFormatter
formatter = pg.PromptFormatter(
input_formatter=KeyValueFormatter(),
output_formatter=JsonValueFormatter(),
)
print(formatter.format_prompt_without_input(summarizer))
コンソール出力:
Summarize text and extract keywords.
Output a JSON-formatted string without outputting any other strings.
Be careful with the order of brackets in the json.
Input Parameters:
- text: Text to summarize
Output Parameters:
- summary: Summary of text
- keywords: Keywords extracted from text
Template:
Input:
text: "This is a sample text to summarize."
Output:
```json
{
"summary": "This is a summary of the text.",
"keywords": [
"sample",
"text",
"summarize"
]
}```
Example 1:
Input:
text: "One sunny afternoon, a group of friends decided to gather at the nearby park to engage in various games and activities. They played soccer, badminton, and basketball, laughing and enjoying each other's company while creating unforgettable memories together."
Output:
```json
{
"summary": "A group of friends enjoyed an afternoon playing sports and making memories at a local park.",
"keywords": [
"friends",
"park",
"sports",
"memories"
]
}```
プロンプトを入力パラメータありで文字列にフォーマットする¶
続いて、プロンプトを入力パラメータありで文字列にフォーマットしてみましょう。
プロンプトを入力パラメータ込みで文字列にフォーマットするには、format_prompt メソッドを使用します。
入力パラメータは、 pg.Value つまり dict を format_prompt メソッドに渡すことで指定できます。
formatter = pg.KeyValuePromptFormatter()
input_value = {
'text': "In the realm of software engineering, developers often collaborate on projects using version control systems like Git. They work together to create and maintain well-structured, efficient code, and tackle issues that arise from implementation complexities, evolving user requirements, and system optimization.",
}
print(formatter.format_prompt(summarizer, input_value))
コンソール出力:
Summarize text and extract keywords.
Input Parameters:
- text: Text to summarize
Output Parameters:
- summary: Summary of text
- keywords: Keywords extracted from text
Template:
Input:
text: "This is a sample text to summarize."
Output:
summary: """This is a summary of the text."""
keywords: [
"sample",
"text",
"summarize"
]
Example 1:
Input:
text: "One sunny afternoon, a group of friends decided to gather at the nearby park to engage in various games and activities. They played soccer, badminton, and basketball, laughing and enjoying each other's company while creating unforgettable memories together."
Output:
summary: """A group of friends enjoyed an afternoon playing sports and making memories at a local park."""
keywords: [
"friends",
"park",
"sports",
"memories"
]
--------
Input:
text: "In the realm of software engineering, developers often collaborate on projects using version control systems like Git. They work together to create and maintain well-structured, efficient code, and tackle issues that arise from implementation complexities, evolving user requirements, and system optimization."
Output:
表示項目を変更する¶
pg.PromptFormatterConfig を使用して、表示項目を変更することができます。
class PromptFormatterConfig(DataClass):
"""Configuration for formatting a prompt.
Attributes:
show_formatter_description (bool): Whether to show the description of the formatter.
show_parameter_info (bool): Whether to show the parameter info of the prompt.
show_template (bool): Whether to show the template of the prompt.
"""
show_formatter_description: bool = True
show_parameter_info: bool = True
show_template: bool = True
たとえば、 Input Parameters や Output Parameters といったパラメータの情報をフォーマットしたくない場合、以下のように指定します。