OpenAIParameters
OpenAIParameters クラスはOpenAI API とやり取りをするための実行パラメーターとリクエストパラメーターを管理するために設計されています。
プロパティ
非同期コールバック用プロパティ
成功かエラーかに関係なく結果を受け取るためには、このコールバックプロパティを使用します:
| プロパティ | 型 | 説明 |
|---|---|---|
onTerminate(または formula) | 4D.Function | 終了時に非同期で呼び出す関数。 カレントプロセスが終了しないように注意してください。 |
成功とエラー処理をより細やかに管理するためにはこれらのコールバックプロパティを使用します:
| プロパティ | 型 | 説明 |
|---|---|---|
onResponse | 4D.Function | リクエストが正常に終了した場合に非同期で呼び出される関数。 カレントプロセスが終了しないように注意してください。 |
onError | 4D.Function | リクエストがエラーで終了した場合に非同期で呼び出される関数。 カレントプロセスが終了しないように注意してください。 |
これらのコールバック関数は、同期コード内での関数によって返される結果のオブジェクト型(OpenAIResult 子クラスのうちのいずれか)と同じものを受け取ります。
詳細な情報については 非同期コードに関するドキュメンテーション を参照してください。
ネットワークプロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
timeout | Real | クライアントレベルのリクエストのデフォルトのタイムアウトをオーバーライドします(秒単位)。 デフォルトは0です。 |
httpAgent | HTTPAgent | クライアントレベルのリクエストのデフォルトのHTTP エージェントをオーバーライドします。 |
maxRetries | Integer | リクエストのリトライの最大回数。 (コードが非同期でない場合、つまり関数が提供されていない場合のみ) |
extraHeaders | Object | リクエストに付随して送信する追加のヘッダー。 |
OpenAPIプロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
user | Text | エンドユーザーを表す固有の識別子。これはOpenAI が不正利用をモニターし検知するのに役立ちます。 |
その他
| プロパティ | 型 | 説明 |
|---|---|---|
throw | Boolean | true の場合、エラーが発生した場合にエラーをスローします。 コールバックフォーミュラが定義されていない場合のみ。 |
継承クラス
特定の用途のためにこのクラスの機能を拡張するために、いくつかのクラスがOpenAIParameters クラスを継承します。 OpenAIParameters 以下はクラスを拡張するクラスの一部です: