openai go

Client API Golang OpenAI

Une implémentation native de Golang pour interagir facilement avec l'API OpenAI.

https://beta.openai.com/docs/api-reference/

Usage

Vous pouvez utiliser une variable d'environnement pour stocker la clé secrète de l'API

 export OPENAI_KEY=[YOUR_KEY]

Pour initialiser le moteur, utilisez ceci :

 e := openai . New ( os . Getenv ( "OPENAI_KEY" ))

Conseils

Modèle

Si vous souhaitez utiliser le modèle le plus puissant pour générer des sorties texte, assurez-vous d'utiliser "text-davinci-003". Ce modèle est défini comme constante openai.ModelTextDavinci003 .

Édition de texte

Vous pouvez utiliser le bundle Completion+Edit pour régénérer la réponse en fonction du dernier contexte.

 e := openai . New ( os . Getenv ( "OPENAI_KEY" ))
ctx := context . Background ()
completionResp , err := e . Completion ( ctx , & openai. CompletionOptions {
	// Choose model, you can see list of available models in models.go file
	Model : openai . ModelTextDavinci001 ,
	// Number of completion tokens to generate response. By default - 1024
	MaxTokens : 1200 ,
	// Text to completion
	Prompt : [] string { "Write a little bit of Wikipedia. What is that?" },
})

editResp , err := e . Edit ( ctx , & EditOptions {
	Model :       ModelTextDavinci001 ,
	Input :       completionResp . Choices [ 0 ],
	Instruction : "Please rewrite a bit more and add more information about Wikipedia in different aspects. Please build based on that for 4 topics" ,
})

Exemple de complétion de texte

Suite à une invite, le modèle renverra une ou plusieurs achèvements prévus.

Remarque : le nombre par défaut de jetons de complétion est de 1024, si vous souhaitez augmenter ou diminuer cette limite, vous devez modifier le paramètre MaxTokens .

 e := openai . New ( os . Getenv ( "OPENAI_KEY" ))
r , err := e . Completion ( context . Background (), & openai. CompletionOptions {
	// Choose model, you can see list of available models in models.go file
	Model : openai . ModelTextDavinci001 ,
	// Number of completion tokens to generate response. By default - 1024
	MaxTokens : 1200 ,
	// Text to completion
	Prompt : [] string { "Write a little bit of Wikipedia. What is that?" },
})

Vous obtiendrez le résultat suivant :

{
  "id" : " cmpl-6SrcYDLCVT7xyHKVNuSLNuhRvwOJ1 " ,
  "object" : " text_completion " ,
  "created" : 1672337322 ,
  "model" : " text-davinci-001 " ,
  "choices" : [
    {
      "text" : " nn Wikipedia is a free online encyclopedia, created and edited by volunteers. " ,
      "index" : 0 ,
      "finish_reason" : " stop "
    }
  ],
  "usage" : {
    "prompt_tokens" : 11 ,
    "completion_tokens" : 15 ,
    "total_tokens" : 26
  }
}

Pour obtenir uniquement le texte, vous devez utiliser le code suivant :

 fmt . Println ( r . Choices [ 0 ]. Text )

Le code complet sera donc :

 package main 


import (
	"context"
	"encoding/json"
	"log"
	"os"
	"testing"
  "github.com/0x9ef/openai-go"
)

func main () {
	e := openai . New ( os . Getenv ( "OPENAI_KEY" ))
	r , err := e . Completion ( context . Background (), & openai. CompletionOptions {
		// Choose model, you can see list of available models in models.go file
		Model : openai . ModelTextDavinci001 ,
		// Text to completion
		Prompt : [] string { "Write a little bit of Wikipedia. What is that?" },
	})

	if b , err := json . MarshalIndent ( r , "" , "  " ); err != nil {
		panic ( err )
	} else {
		fmt . Println ( string ( b ))
	}

	// Wikipedia is a free online encyclopedia, created and edited by volunteers.
	fmt . Println ( "What is the Wikipedia?" , r . Choices [ 0 ]. Text )
}

Liste/récupération de modèles

Répertorie les modèles actuellement disponibles et fournit des informations de base sur chacun, telles que le propriétaire et la disponibilité.

 e := openai . New ( os . Getenv ( "OPENAI_KEY" ))
r , err := e . ListModels ( context . Background ())
if err != nil {
	log . Fatal ( err )
}

Vous obtiendrez le résultat suivant :

{
  "data" : [
    {
      "id" : " babbage " ,
      "object" : " model " ,
      "owned_by" : " openai "
    },
    {
      "id" : " ada " ,
      "object" : " model " ,
      "owned_by" : " openai "
    },
    {
      "id" : " text-davinci-002 " ,
      "object" : " model " ,
      "owned_by" : " openai "
    },
    {
      "id" : " davinci " ,
      "object" : " model " ,
      "owned_by" : " openai "
    },
    ...
  ]
}

Pour récupérer des informations sur le modèle spécifié au lieu de tous les modèles, vous pouvez procéder comme suit :

 e := openai . New ( os . Getenv ( "OPENAI_KEY" ))
r , err := e . RetrieveModel ( context . Background (), & openai. RetrieveModelOptions {
	ID : openai . ModelDavinci ,
})
if err != nil {
	log . Fatal ( err )
}

Licence

MIT