メインコンテンツまでスキップ
バージョン: 20 R9 BETA

OpenAI

OpenAI クラスは、様々なOpenAI API リソースにアクセスするためのクライアントを提供します。 これにはAPI 設定を管理するプロパティやOpenAI エンドポイントへの HTTPリクエストを実行するためのメソッドなどが含まれます。

設定プロパティ

プロパティ名説明任意
apiKeyTextあなたの OpenAI API キーOpenAI では必須
baseURLTextOpenAI API リクエストのためのベースURL。
組織Textあなたの OpenAI 組織 ID。
projectTextあなたの OpenAI プロジェクト ID。

追加のHTTPプロパティ

プロパティ名説明
timeoutRealタイムアウトが発生するまでの時間(秒)。
maxRetriesReal失敗した場合の最大再試行回数。
httpAgent4D.HTTPAgentリクエストに使用された HTTPエージェント。
customHeadersRealHTTP リクエストに含めるカスタムのヘッダー。

Class constructor

OpenAI クライアントクラスのインスタンスを作成します。

引数名説明
apiKeyテキストまたはオブジェクトapiKey。型としてテキストまたはオブジェクトを指定することができます。

API キー

// テキストとして渡す
var $client:=cs.AIKit.OpenAI.new("your api key")
// オブジェクトとして渡す
var $client:=cs.AIKit.OpenAI.new({apiKey: "your api key"})

サーバーURL

互換性のあるプロバイダー API に対しては、サーバーURL を設定することができます。

var $client:=cs.AIKit.OpenAI.new({apiKey: "your api key"; baseURL: "https://server.ai"})

あるいはインスタンスを作成した後に変更する場合

$client.baseURL:="https://server.ai"

APIリソース

API はOpenAI のサービスとシームレスにやりとりすることを可能にする複数のリソースへのアクセスを提供します。 それぞれのリソースは専用のAPI クラスにカプセル化されており、様々な機能と対話するための構造化された、直感的な方法を提供しています。

プロパティ名説明
modelsOpenAIModelsAPIModels API へのアクセス。
chatOpenAIChatAPIChat API へのアクセス。
imagesOpenAIImagesAPI画像 API へのアクセス。
moderationsOpenAIModerationsAPIモデレーションAPI へのアクセス。

使用例

$client.chat.completions.create(...)
$client.images.generate(...)
$client.model.lists(...)