OpenAIResult
OpenAIResult クラスはHTTP リクエストからのレスポンスを管理するために設計されており、リクエストの成否の評価、本文コンテンツの取得、そして処理中に起きたかもしれないあらゆるエラーの収集などの機能を提供します。
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
request | 4D.HTTPRequest | The HTTP request |
計算プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
success | Boolean | HTTP リクエストが成功したかどうかを示すブール値。 |
errors | Collection | エラーのコレクションを返します。 これらはネットワークエラーまたは OpenAI から返されたエラーである可能性があります。 |
terminated | Boolean | HTTP リクエストが終了したかどうかを示すブール値。 |
headers | Object | レスポンスのヘッダーをオブジェクトとして返します。 |
rateLimit | Object | レスポンスヘッダーからのレート制限情報を返します。 |
usage | Object | レスポンス本文から使用状況の情報(トークン数)を返します(あれば)。 |
usage
usage プロパティは、API レスポンスから、トークン使用状況を格納したオブジェクトを返します。 この構造は、使用しているAPI エンドポイントによって異なります。
注意: 異なるOpenAI 互換サービスの場合には、usage オブジェクト内に異なるフィールドを返す可能性があります。 ここで示されている構造は、OpenAI のAPI の場合に基づいています。 他のプロバイダーの場合には全てのフィールドが含まれていない場合もあります。
エンドポイント特有のusage オブジェクトの構造については、それぞれの戻り値のクラスのドキュメンテーションを参照してください:
- OpenAIChatCompletionsResult - チャット補完の usage
- OpenAIChatCompletionsStreamResult - ストリーミングチャットの usage
- OpenAIEmbeddingsResult - 埋め込みの usage
- OpenAIImagesResult - 画像生成の usage
rateLimit
rateLimit プロパティはレスポンスヘッダーからのレート制限情報を格納しているオブジェクトを返します。
この情報には上限、残りのリクエスト、そしてリクエストとトークン両方のリセットまでの時間が含まれます。
レート制限と使用される特定のヘッダーの詳細な情報については、OpenAI のレート制限についてのドキュメンテーション を参照してください。
rateLimit オブジェクトの構造は以下のようになっています:
| フィールド | 型 | 説明 |
|---|---|---|
limit.request | Integer | 許可されたリクエスト数。 |
limit.tokens | Integer | 許可されたトークン数。 |
remaining.request | Integer | 残りのリクエスト数。 |
remaining.tokens | Integer | 残りのトークン数。 |
reset.request | String | リクエストの制限がリセットされるまでの時間。 |
reset.tokens | String | トークンの制限がリセットされるまでの時間。 |
関数
throw()
errors コレクション内の最初のエラーをスローします。 この関数は呼び出しスタック内のエラーを辿っていくのに有用です。
継承クラス
特定の用途のためにこのクラスの機能を拡張するために、いくつかのクラスがOpenAIResult クラスを継承します。 以下は OpenAIResult クラスを拡張するクラスの一部です: