Open AI Responses provider with Background support

[marceloandrader]

Hey there,

As part of a feature I'm working on, I needed to use the openai responses endpoint with a deep-research model in background mode, this will return the response object immediately while the output is being generated. And a webhook will be called when the response status is complete.

        $agent = OneShot::make(
            NeuronAiProviders::OPENAI_RESPONSES,
            'o4-mini-deep-research',
            [
                'background' => true,
                'max_output_tokens' => 15_000,
            ]
        )
            ->addTool(
                new ProviderTool('web_search_preview')
            )
            ->setInstructions(
                <<<'PROMPT'
DEEP RESEARCH REQUEST
PROMPT
            );

        $response = $agent->chat(new UserMessage(<<<'PROMPT'
Deep research user request
PROMPT
        ));

        dump($response);

The neuronai chat method in my Agent using openai responses, raise an error in this condition because the response doesn't have a user message. It fails in:

   ErrorException 

  Undefined array key 0

  at vendor/neuron-core/neuron-ai/src/Providers/OpenAI/Responses/OpenAIResponses.php:93
     89▕                 fn (array $message): bool => $message['type'] === 'message' && $message['role'] == MessageRole::ASSISTANT->value
     90▕             )
     91▕         );
     92▕ 
  ➜  93▕         $content = $messages[0]['content'][0];
     94▕ 
     95▕         $message = new AssistantMessage($content['text']);

To avoid this error I applied the following patch using https://docs.cweagans.net/composer-patches/ in src/Providers/OpenAI/Responses/OpenAIResponses.php

93,98c93
<         if ($messages !== []) {
<             $content = $messages[0]['content'][0];
<             $message = new AssistantMessage($content['text']);
<         } else if (array_key_exists('id', $response)) {
<             return new AssistantMessage($response['id']);
<         }
---
>         $content = $messages[0]['content'][0];
99a95
>         $message = new AssistantMessage($content['text']);

to allow me grab the response id in my app code, I'll live with this for now, but I was wondering if there is any plan of better handling this scenario for background jobs on openai.

Thanks

[ilvalerione]

Do you have a link to the openai documentation about this feature?

[marceloandrader]

https://platform.openai.com/docs/api-reference/responses/create#responses_create-background

[jeancodogno]

https://platform.openai.com/docs/guides/background