openai go

Golang OpenAI API クライアント

OpenAI API と簡単に対話できる Golang ネイティブ実装。

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

使用法

環境変数を使用して API 秘密キーを保存できます

 export OPENAI_KEY=[YOUR_KEY]

エンジンを初期化するには、これを使用します。

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

ヒント

モデル

最も強力なモデルを使用してテキスト出力を生成したい場合は、必ず「text-davinci-003」を使用してください。このモデルは、定数openai.ModelTextDavinci003として定義されます。

テキスト版

Completion+Edit バンドルを使用すると、最後のコンテキストに基づいて応答を再生成できます。

 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" ,
})

テキスト補完の例

プロンプトが与えられると、モデルは 1 つ以上の予測された完了を返します。

注: 完了トークンのデフォルト数は 1024 です。この制限を増減したい場合は、 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?" },
})

次の出力が得られます。

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

テキストのみを取得するには、次のコードを使用する必要があります。

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

したがって、完全なコードは次のようになります。

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

モデルのリスト/取得

現在入手可能なモデルをリストし、所有者や入手可能性など、各モデルに関する基本情報を提供します。

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

次の出力が得られます。

{
  "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 "
    },
    ...
  ]
}

すべてのモデルではなく、指定したモデルに関する情報を取得するには、次のようにします。

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

ライセンス

マサチューセッツ工科大学