gpt var

Readme para GPTvar

Visão geral

GPTVAR facilita a comunicação fácil com a API OpenAI, permitindo o envio contínuo de instruções e recebimento de respostas. Ele pode ser adaptado para outros modelos, simplificando a criação de valores para variáveis ​​usando conteúdo gerado por GPT.

Pré -requisitos

• Node.js
• Uma chave de API OpenAi

Instalação

Instale GPTVAR usando o NPM:

npm install gpt-var

Início rápido

Utilize GPTVAR em algumas etapas simples:

1. Importar a classe

   Comece importando GPTVAR para o seu arquivo de texto datilografado:

    import GPTVAR from 'gpt-var' ;

2. Crie uma instância

   Inicialize GPTVAR com sua chave da API OpenAI e, opcionalmente, seu modelo preferido. Para uma lista de modelos, visite a visão geral dos modelos Openai.

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

3. Envie um prompt

   Ligue para prompt com sua mensagem e o formato desejado. Os formatos podem ser 'qualquer', 'matriz', 'objeto' ou 'objectinary'.

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

4. Lidar com respostas

   prompt retorna uma promessa com a resposta do modelo GPT, que você pode processar conforme necessário.

Método

prompt(message: string, format: string)

Este método envia uma mensagem para o modelo GPT, esperando uma resposta no formato especificado.

• messages : a sequência de entrada para o modelo GPT.
• format : o formato de resposta esperado. Opções:
  • any : retorna uma corda crua, adequada para formatos flexíveis ou não especificados.
  • object : espera um objeto JSON, ideal para dados estruturados.
  • array : espera uma matriz JSON, ótima para listas ou seqüências.
  • objectInArray : espera uma variedade de objetos JSON, útil para listas estruturadas.

Exemplo de uso:

1. Formato: any

   Retorna a resposta como uma corda crua, ideal para dados não estruturados.

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

   Exemplo de resposta:

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

2. Formato: object

   Espera uma resposta de objeto JSON.

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

   Exemplo de resposta:

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

3. Formato: array

   Espera uma resposta de matriz JSON.

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

   Exemplo de resposta:

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

4. Formato: objectInArray

   Espera uma variedade de objetos JSON.

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

   Exemplo de resposta:

    [
      {
        "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

• Verifique se sua chave de API do OpenAI é válida.
• O modelo padrão é 'GPT-3.5-turbo'; Outros modelos podem ser especificados.
• Ajuste o formato de resposta para atender às suas necessidades.

Apoiar

Para obter suporte, problemas ou solicitações de recursos, registre um problema em nosso repositório do GitHub.