Asynchronous Call

If you do not want to wait for the OpenAPI response when making a request to its API, you need to use asynchronous code.

You must provide a 4D.Formula to receive the result. See OpenAIParameters for a list of them.

The asynchronous method is based on 4D.HTTPRequest, so the response will be received within the current process.

⚠️ If your process ends at the conclusion of the current method (e.g., using New process, or playing in the method editor), the callback formula might not be called asynchronously. In such cases, consider using CALL WORKER or CALL FORM.

Examples of Usage

model list

$client.models.list({formula: Formula(MyReceiveMethod($1))})

$1 will be an instance of OpenAIModelListResult, so MyReceiveMethod method could be:

#DECLARE($result: cs.AIKit.OpenAIModelListResult)

If($result.success)

   Form.models:=$result.models

Else

  Alert($result.errors.formula(Formula(JSON Stringify($1))).join("\n"))

End if

chat completions

var $messages:=[{role: "system"; content: "You are a helpful assistant."}]
$messages.push({role: "user"; content: "Could you explain me why 42 is a special number"})

$client.chat.completions.create($messages; { onResponse: Formula(MyChatCompletionsReceiveMethod($1))})

$1 will be an instance of OpenAIChatCompletionsResult, so MyChatCompletionsReceiveMethod method could be:

#DECLARE($result: cs.AIKit.OpenAIChatCompletionsResult)

ASSERT($result.success) // We use onResponse here, callback receive only if success
Form.assistantMessage:=$result.choices[0].text