prompt ezダウンロード - prompt ezソースコードのダウンロード

プロンプト-EZ

大規模な言語モデル（LLMS）およびAIアプリケーションのTypeScriptで構造化されたプロンプトを作成するための使いやすいプロンプトビルダー。

このプロジェクトの目的は、OpenAI、Anthropic、Google GeminiなどのさまざまなAIモデルと互換性がある、単純なインターフェイスを通じて、迅速な読みやすさと保守性を向上させることです。また、人類が推奨するXMLベースのプロンプト構造を使用して、迅速な品質とモデルの理解を改善します。

もともとDreamloomの内部ニーズを満たすために開発された私たちは、より広いコミュニティに利益をもたらすためにオープンソースをかけました。 GitHubに関する改善とその他のフィードバックについての提案を歓迎します。

GitHubのプロジェクトに貢献します

特徴

XMLのようなタグを使用した構造化プロンプト
直感的な迅速な構築のための流fluentで鎖のAPI
複雑なプロンプト構造を作成するためのネストされたタグをサポートします
テキスト挿入とリスト作成の簡単な方法
柔軟なプロンプト生成のための動的入力処理
LLM相互作用とAI搭載アプリケーション向けに最適化されています
Openai、Anthropic、Google Geminiなどを含む人気のあるAIモデルと互換性があります
人類が好むXMLベースのプロンプト構造を順守します

なぜXMLベースのプロンプト？

このプロジェクトは、XMLベースのプロンプトを利用しています。これは、人類のClaude AIモデルに好ましい構造です。 Anthropicのドキュメントによると、プロンプトでXMLタグを使用すると、いくつかの利点があります。

異なるプロンプトコンポーネントの明確な分離
AIモデルの構造とコンテキストの強化
モデルの理解と応答の質が向上しました

Claudeに人類が推奨していますが、他のLLMやAIモデルと連携する場合、プロンプトエンジニアリングへのこの構造化されたアプローチは非常に有益であり、モデルがプロンプトをよりよく理解し、応答し、より正確で有用なものにします。

インストール

NPMを使用してPROMPT-EZをインストールしてください：

npm install prompt-ez

使用法

PromptBuilderクラス

PromptBuilderクラスは、構造化されたプロンプトを作成するためのメインインターフェイスです。メソッドの簡単な概要は次のとおりです。

tag(name: string, contentFn?: (builder: PromptBuilder) => void): PromptBuilder
- プロンプトにXMLのようなタグを作成します。
- name ：タグの名前。
- contentFn ：タグ内にコンテンツを追加するオプションの関数。
- 返品：チェーン用のPromptBuilderインスタンス。
text(text: string): PromptBuilder
- プロンプトにプレーンテキストを追加します。
- 返品：チェーン用のPromptBuilderインスタンス。
list(items: string[]): PromptBuilder
- プロンプトに番号付きリストを作成します。
- 返品：チェーン用のPromptBuilderインスタンス。
inputs(): PromptBuilder
- 動的入力のプレースホルダーを追加します。
- 返品：チェーン用のPromptBuilderインスタンス。
build(params?: Record<string, unknown>): string
- 最終的なプロンプト文字列を構築します。
- params ：動的入力のキー値ペアを持つオプションオブジェクト。
  - プリミティブ値（文字列、数字、ブール値）をサポートします
  - それらをJSON文字列に変換して、配列とオブジェクトを処理します
  - 空の配列、空のオブジェクト、null、未定義、および空の文字列値をフィルターします
- 返品：XMLタグとして動的入力が挿入された完全なプロンプトが文字列として挿入されています。

例1：基本的なプロンプト作成

構造化されたプロンプトを作成する簡単な例を次に示します。

 import PromptBuilder from 'prompt-ez' ;

const prompt = new PromptBuilder ( )
  . tag ( 'system' , b => b
    . text ( 'You are a helpful AI assistant.' )
    . text ( 'Please provide accurate and concise information.' )
  )
  . tag ( 'task' , b => b
    . text ( 'Explain the benefits of regular exercise.' )
  )
  . tag ( 'output_format' , b => b
    . text ( 'Provide the explanation in a paragraph.' )
  )
  . build ( ) ;

console . log ( prompt ) ;

これにより、次のプロンプトが生成されます。

< system >
You are a helpful AI assistant.
Please provide accurate and concise information.
</ system >
< task >
Explain the benefits of regular exercise.
</ task >
< output_format >
Provide the explanation in a paragraph.
</ output_format >

例2：動的入力の使用

プロンプトで動的入力を使用する方法は次のとおりです。

 const promptWithInputs = new PromptBuilder ( )
  . tag ( 'system' , b => b
    . text ( 'You are a language translator.' )
  )
  . tag ( 'task' , b => b
    . text ( 'Translate the following text:' )
    . inputs ( )
  )
  . build ( {
    source_language : 'English' ,
    target_language : 'French' ,
    text : 'Hello, how are you?'
  } ) ;

console . log ( promptWithInputs ) ;

これが生成します：

< system >
You are a language translator.
</ system >
< task >
Translate the following text:
< source_language >English</ source_language >
< target_language >French</ target_language >
< text >Hello, how are you?</ text >
</ task >

例3：複雑なプロンプト構造

ネストされたタグ、リスト作成、動的入力を示すより複雑な例を次に示します。

 import PromptBuilder from 'prompt-ez' ;

export const AI_MEDICAL_DIAGNOSIS_PROMPT = new PromptBuilder ( )
  . tag ( 'medical_diagnosis_prompt' , ( builder ) => 
    builder
      . tag ( 'role' , ( b ) => b . text ( 'Act as an AI medical assistant. Analyze the provided patient information and suggest three potential diagnoses with recommended next steps.' ) )
      . inputs ( )
      . tag ( 'guidelines' , ( b ) => 
        b
          . text ( 'For each potential diagnosis:' )
          . list ( [
            'Consider the patient's symptoms, medical history, and test results' ,
            'Provide a brief explanation of the condition' ,
            'List key symptoms that align with the diagnosis' ,
            'Suggest additional tests or examinations if needed' ,
            'Outline potential treatment options' ,
            'Indicate the urgency level (e.g., immediate attention, routine follow-up)' ,
            'Highlight any lifestyle changes or preventive measures' ,
            'Consider possible complications if left untreated' ,
            'Use medical terminology appropriately, with layman explanations' ,
            'Provide a confidence level for each diagnosis (low, medium, high)' ,
            'First analyze the information thoroughly, then produce the output'
          ] )
      )
      . tag ( 'reminder' , ( b ) => b . text ( 'Ensure the diagnoses are evidence-based and consider a range of possibilities from common to rare conditions. Always emphasize the importance of consulting with a human healthcare professional for a definitive diagnosis.' ) )
      . tag ( 'output_format' , ( b ) => 
        b . list ( [
          'Present information in a clear, structured manner' ,
          'Use bullet points for symptoms and recommendations' ,
          'Include relevant medical terms with brief explanations' ,
          'Provide a summary of each potential diagnosis' ,
          'Suggest follow-up questions to gather more information if needed' ,
          'End with a disclaimer about the limitations of AI diagnosis'
        ] )
      )
  )
  . build ( {
    patient_age : 45 ,
    patient_gender : 'Female' ,
    main_symptoms : 'Persistent headache, blurred vision, and occasional dizziness for the past two weeks' ,
    medical_history : 'Hypertension, controlled with medication' ,
    recent_tests : 'Blood pressure: 150/95 mmHg, Blood sugar: 110 mg/dL (fasting)'
  } ) ;

console . log ( AI_MEDICAL_DIAGNOSIS_PROMPT ) ;

これにより、AI医療診断シナリオの複雑で構造化されたプロンプトが生成されます。

< medical_diagnosis_prompt >
< role >Act as an AI medical assistant. Analyze the provided patient information and suggest three potential diagnoses with recommended next steps.</ role >
< patient_age >45</ patient_age >
< patient_gender >Female</ patient_gender >
< main_symptoms >Persistent headache, blurred vision, and occasional dizziness for the past two weeks</ main_symptoms >
< medical_history >Hypertension, controlled with medication</ medical_history >
< recent_tests >Blood pressure: 150/95 mmHg, Blood sugar: 110 mg/dL (fasting)</ recent_tests >
< guidelines >
For each potential diagnosis:
1. Consider the patient's symptoms, medical history, and test results
2. Provide a brief explanation of the condition
3. List key symptoms that align with the diagnosis
4. Suggest additional tests or examinations if needed
5. Outline potential treatment options
6. Indicate the urgency level (e.g., immediate attention, routine follow-up)
7. Highlight any lifestyle changes or preventive measures
8. Consider possible complications if left untreated
9. Use medical terminology appropriately, with layman explanations
10. Provide a confidence level for each diagnosis (low, medium, high)
11. First analyze the information thoroughly, then produce the output
</ guidelines >
< reminder >Ensure the diagnoses are evidence-based and consider a range of possibilities from common to rare conditions. Always emphasize the importance of consulting with a human healthcare professional for a definitive diagnosis.</ reminder >
< output_format >
1. Present information in a clear, structured manner
2. Use bullet points for symptoms and recommendations
3. Include relevant medical terms with brief explanations
4. Provide a summary of each potential diagnosis
5. Suggest follow-up questions to gather more information if needed
6. End with a disclaimer about the limitations of AI diagnosis
</ output_format >
</ medical_diagnosis_prompt >