gpt var

Readme para gptvar

Descripción general

GPTVAR facilita la comunicación fácil con la API de OpenAI, lo que permite el envío perfecto de indicaciones y recepción de respuestas. Se puede adaptar para otros modelos, simplificando la creación de valores para variables que usan contenido generado por GPT.

Requisitos previos

• Nodo.js
• Una llave de API de OpenAI

Instalación

Instale GPTVAR usando NPM:

npm install gpt-var

Comienzo rápido

Utilice GPTVAR en algunos simples pasos:

1. Importar la clase

   Comience por importar GPTVAR en su archivo TypeScript:

    import GPTVAR from 'gpt-var' ;

2. Crear una instancia

   Inicialice GPTVAR con su tecla API OpenAI y, opcionalmente, su modelo preferido. Para obtener una lista de modelos, visite la descripción general de los modelos Operai.

    const gptVar = new GPTVAR ( 'your-openai-api-key' , 'model-name' ) ;

3. Enviar un aviso

   Llame prompt con su mensaje y el formato deseado. Los formatos pueden ser 'cualquiera', 'matriz', 'objeto' o 'ObjectInArray'.

    gptVar . prompt ( 'Your prompt here' , 'any' ) . then ( response => {
     console . log ( response ) ;
   } ) . catch ( error => {
     console . error ( error ) ;
   } ) ;

4. Manejar respuestas

   prompt devuelve una promesa con la respuesta del modelo GPT, que luego puede procesar según sea necesario.

Método

prompt(message: string, format: string)

Este método envía un mensaje al modelo GPT, esperando una respuesta en el formato especificado.

• messages : la cadena de entrada para el modelo GPT.
• format : el formato de respuesta esperado. Opciones:
  • any : Devuelve una cadena RAW, adecuada para formatos flexibles o no especificados.
  • object : espera un objeto JSON, ideal para datos estructurados.
  • array : espera una matriz JSON, ideal para listas o secuencias.
  • objectInArray : espera una matriz de objetos JSON, útil para listas estructuradas.

Ejemplo de uso:

1. Formato: any

   Devuelve la respuesta como una cadena sin procesar, ideal para datos no estructurados.

    gptVar . prompt ( 'Tell me a joke' , 'any' ) . then ( response => {
     console . log ( 'Response:' , response ) ;
   } ) ;

   Respuesta de ejemplo:

    "Why don't scientists trust atoms? Because they make up everything!"
   

2. Formato: object

   Espera una respuesta de objeto JSON.

    gptVar . prompt ( 'Provide details about the Eiffel Tower' , 'object' ) . then ( response => {
     console . log ( 'Response:' , response ) ;
   } ) ;

   Respuesta de ejemplo:

   {
     "name" : " Eiffel Tower " ,
     "location" : " Paris, France " ,
     "height" : " 300 meters "
   }

3. Formato: array

   Espera una respuesta de matriz JSON.

    gptVar . prompt ( 'List three famous scientists' , 'array' ) . then ( response => {
     console . log ( 'Response:' , response ) ;
   } ) ;

   Respuesta de ejemplo:

   [ " Albert Einstein " , " Marie Curie " , " Isaac Newton " ]

4. Formato: objectInArray

   Espera una variedad de objetos JSON.

    gptVar . prompt ( 'List major cities with their countries and populations' , 'objectInArray' ) . then ( response => {
      console . log ( 'Response:' , response ) ;
    } ) ;

   Respuesta de ejemplo:

    [
      {
        "city" : " New York City " ,
        "country" : " USA " ,
        "population" : " 8.4 million "
      },
      {
        "city" : " Tokyo " ,
        "country" : " Japan " ,
        "population" : " 9.3 million "
      },
      {
        "city" : " London " ,
        "country" : " UK " ,
        "population" : " 8.9 million "
      }
    ]

Notas

• Asegúrese de que su tecla API de OpenAI sea válida.
• El modelo predeterminado es 'GPT-3.5-TURBO'; Se pueden especificar otros modelos.
• Ajuste el formato de respuesta para satisfacer sus necesidades.

Apoyo

Para obtener soporte, problemas o solicitudes de funciones, presente un problema en nuestro repositorio de GitHub.