OpenAIResult

The OpenAIResult class is designed to handle the response from HTTP requests and provides functions to evaluate the success of the request, retrieve body content, and collect any errors that may have occurred during processing.

プロパティ

プロパティ	型	説明
request	4D.HTTPRequest	The HTTP request

Computed properties

プロパティ	型	説明
success	Boolean	A Boolean indicating whether the HTTP request was successful.
errors	Collection	Returns a collection of errors. These could be network errors or errors returned by OpenAI.
terminated	Boolean	A Boolean indicating whether the HTTP request was terminated.
headers	Object	Returns the response headers as an object.
rateLimit	Object	Returns rate limit information from the response headers.
効果	Object	Returns usage information from the response body if any.

rateLimit

The rateLimit property returns an object containing rate limit information from the response headers. This information includes the limits, remaining requests, and reset times for both requests and tokens.

For more details on rate limits and the specific headers used, refer to the OpenAI Rate Limits Documentation.

The structure of the rateLimit object is as follows:

フィールド	型	説明
limit.request	Integer	Number of allowed requests.
limit.tokens	Integer	Number of allowed tokens.
remaining.request	Integer	Number of remaining requests.
remaining.tokens	Integer	Number of remaining tokens.
reset.request	文字列	Time until request limit resets.
reset.tokens	文字列	Time until token limit resets.

関数

throw()

Throws the first error in the errors collection. This function is useful for propagating errors up the call stack.

Inherited Classes

Several classes inherit from OpenAIResult to extend its functionality for specific use cases. Below are some of the classes that extend OpenAIResult:

• OpenAIChatCompletionsResult
• OpenAIChatCompletionsStreamResult
• OpenAIImagesResult
• OpenAIModelResult
• OpenAIModelListResult
• OpenAIModerationResult