prompt ez

aviso-EZ

Un constructor de indicadores fáciles de usar para crear indicaciones estructuradas en TypeScript para modelos de idiomas grandes (LLM) y aplicaciones de IA.

Este proyecto tiene como objetivo mejorar la lectura rápida y la mantenibilidad a través de una interfaz simple, compatible con varios modelos de IA de OpenAI, Anthrope, Google Gemini y más. También utiliza una estructura rápida basada en XML recomendada por Anthrope para mejorar la calidad rápida y la comprensión del modelo.

Originalmente desarrollado para satisfacer las necesidades internas de Dreamloom, lo hemos obtenido para beneficiar a la comunidad en general. Agradecemos sus sugerencias para mejoras y otros comentarios sobre GitHub.

Contribuir al proyecto en Github

Características

• Indicaciones estructuradas utilizando etiquetas tipo XML
• API con fluidez y encadenable para la construcción intuitiva rápida
• Soporte para etiquetas anidadas para crear estructuras rápidas complejas
• Métodos simples para la inserción de texto y la creación de listas
• Manejo dinámico de entrada para una generación de inmediato flexible
• Optimizado para interacciones LLM y aplicaciones con IA
• Compatible con modelos de IA populares que incluyen Openai, Anthrope, Google Gemini y otros
• Se adhiere a la estructura rápida basada en XML preferida de Anthrope

¿Por qué las indicaciones basadas en XML?

Este proyecto utiliza indicaciones basadas en XML, que es la estructura preferida para el modelo Claude AI de Anthrope. Según la documentación de Anthrope, el uso de etiquetas XML en indicaciones ofrece varias ventajas:

• Separación clara de diferentes componentes inmediatos
• Estructura y contexto mejorados para el modelo AI
• Comprensión de modelo mejorada y calidad de respuesta

Si bien lo recomienda antrópico para Claude, este enfoque estructurado para la ingeniería rápida puede ser extremadamente beneficioso cuando se trabaja con otros modelos LLM y IA también, ayudando a los modelos a comprender y responder mejor a sus indicaciones, haciéndolos más precisos y útiles.

Instalación

Instale el indicador-EZ usando NPM:

npm install prompt-ez

Uso

Clase de consultor

La clase PromptBuilder es la interfaz principal para crear indicaciones estructuradas. Aquí hay una descripción general rápida de sus métodos:

• tag(name: string, contentFn?: (builder: PromptBuilder) => void): PromptBuilder

  • Crea una etiqueta tipo XML en el mensaje.
  • name : El nombre de la etiqueta.
  • contentFn : función opcional para agregar contenido dentro de la etiqueta.
  • Devuelve: La instancia de PRoCBuilder para encadenar.

• text(text: string): PromptBuilder

  • Agrega texto plano al mensaje.
  • Devuelve: La instancia de PRoCBuilder para encadenar.

• list(items: string[]): PromptBuilder

  • Crea una lista numerada en el mensaje.
  • Devuelve: La instancia de PRoCBuilder para encadenar.

• inputs(): PromptBuilder

  • Agrega un marcador de posición para entradas dinámicas.
  • Devuelve: La instancia de PRoCBuilder para encadenar.

• build(params?: Record<string, unknown>): string

  • Construye la cadena de inmediato final.
  • params : objeto opcional con pares de valor clave para entradas dinámicas.
    • Admite valores primitivos (cadena, número, booleano)
    • Maneja matrices y objetos convirtiéndolos en cuerdas json
    • Filma matrices vacías, objetos vacíos, valores nulos, indefinidos y vacíos de cadena
  • Devuelve: el mensaje completo como una cadena, con entradas dinámicas insertadas como etiquetas XML.

---

Ejemplo 1: Creación de información básica

Aquí hay un ejemplo simple de crear un mensaje estructurado:

 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 ) ;

Esto genera el siguiente mensaje:

< 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 >

Ejemplo 2: Uso de entradas dinámicas

Aquí le mostramos cómo usar entradas dinámicas en sus indicaciones:

 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 ) ;

Esto produce:

< 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 >

Ejemplo 3: estructura rápida compleja

Aquí hay un ejemplo más complejo que demuestra etiquetas anidadas, creación de listas e entradas dinámicas:

 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 ) ;

Esto generará un indicador complejo y estructurado para un escenario de diagnóstico médico de IA:

< 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 >

Que contribuye

¡Agradecemos las contribuciones! Consulte nuestra guía de contribución para obtener más detalles sobre cómo comenzar.

Licencia

Pront-EZ se publica bajo la licencia MIT. Consulte el archivo de licencia para obtener más detalles.