fix(OpenAI): Apply OpenAI-Beta to all Assistant type resources (#701)

Author: iBotPeaches

src/Resources/Threads.php

@@ -32,7 +32,9 @@ public function create(array $parameters = []): ThreadResponse
         $payload = Payload::create('threads', $parameters);
 
         /** @var Response<array{id: string, object: string, created_at: int, tool_resources: ?array{code_interpreter?: array{file_ids: array<int,string>}, file_search?: array{vector_store_ids: array<int,string>}}, metadata: array<string, string>}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return ThreadResponse::from($response->data(), $response->meta());
     }
@@ -49,7 +51,9 @@ public function createAndRun(array $parameters): ThreadRunResponse
         $payload = Payload::create('threads/runs', $parameters);
 
         /** @var Response<array{id: string, object: string, created_at: int, thread_id: string, assistant_id: string, status: string, required_action?: array{type: string, submit_tool_outputs: array{tool_calls: array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}}, last_error: ?array{code: string, message: string}, expires_at: ?int, started_at: ?int, cancelled_at: ?int, failed_at: ?int, completed_at: ?int, model: string, instructions: ?string, tools: array<int, array{type: 'code_interpreter'}|array{type: 'file_search'}|array{type: 'function', function: array{description: string, name: string, parameters: array<string, mixed>}}>, metadata: array<string, string>, usage?: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int}, incomplete_details: ?array{reason: string}, temperature: float|int|null, top_p: null|float|int, max_prompt_tokens: ?int, max_completion_tokens: ?int, truncation_strategy: array{type: string, last_messages: ?int}, tool_choice: string|array{type: string, function?: array{name: string}}, response_format: string|array{type: 'text'|'json_object'}}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return ThreadRunResponse::from($response->data(), $response->meta());
     }
@@ -68,7 +72,9 @@ public function createAndRunStreamed(array $parameters): StreamResponse
 
         $payload = Payload::create('threads/runs', $parameters);
 
-        $response = $this->transporter->requestStream($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestStream($payload);
 
         return new StreamResponse(ThreadRunStreamResponse::class, $response);
     }
@@ -83,7 +89,9 @@ public function retrieve(string $id): ThreadResponse
         $payload = Payload::retrieve('threads', $id);
 
         /** @var Response<array{id: string, object: string, created_at: int, tool_resources: ?array{code_interpreter?: array{file_ids: array<int,string>}, file_search?: array{vector_store_ids: array<int,string>}}, metadata: array<string, string>}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return ThreadResponse::from($response->data(), $response->meta());
     }
@@ -100,7 +108,9 @@ public function modify(string $id, array $parameters): ThreadResponse
         $payload = Payload::modify('threads', $id, $parameters);
 
         /** @var Response<array{id: string, object: string, created_at: int, tool_resources: ?array{code_interpreter?: array{file_ids: array<int,string>}, file_search?: array{vector_store_ids: array<int,string>}}, metadata: array<string, string>}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return ThreadResponse::from($response->data(), $response->meta());
     }
@@ -115,7 +125,9 @@ public function delete(string $id): ThreadDeleteResponse
         $payload = Payload::delete('threads', $id);
 
         /** @var Response<array{id: string, object: string, deleted: bool}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return ThreadDeleteResponse::from($response->data(), $response->meta());
     }

src/Resources/ThreadsMessages.php

@@ -27,7 +27,9 @@ public function create(string $threadId, array $parameters): ThreadMessageRespon
         $payload = Payload::create("threads/$threadId/messages", $parameters);
 
         /** @var Response<array{id: string, object: string, created_at: int, thread_id: string, role: string, content: array<int, array{type: 'image_url', image_url: array{url: string, detail?: string}}|array{type: 'image_file', image_file: array{file_id: string, detail?: string}}|array{type: 'text', text: array{value: string, annotations: array<int, array{type: 'file_citation', text: string, file_citation: array{file_id: string, quote?: string}, start_index: int, end_index: int}|array{type: 'file_path', text: string, file_path: array{file_id: string}, start_index: int, end_index: int}>}}>, assistant_id: ?string, run_id: ?string, attachments?: array<int, array{file_id: string, tools: array<int, array{type: 'file_search'}|array{type: 'code_interpreter'}>}>, metadata: array<string, string>}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return ThreadMessageResponse::from($response->data(), $response->meta());
     }
@@ -42,7 +44,9 @@ public function retrieve(string $threadId, string $messageId): ThreadMessageResp
         $payload = Payload::retrieve("threads/$threadId/messages", $messageId);
 
         /** @var Response<array{id: string, object: string, created_at: int, thread_id: string, role: string, content: array<int, array{type: 'image_url', image_url: array{url: string, detail?: string}}|array{type: 'image_file', image_file: array{file_id: string, detail?: string}}|array{type: 'text', text: array{value: string, annotations: array<int, array{type: 'file_citation', text: string, file_citation: array{file_id: string, quote?: string}, start_index: int, end_index: int}|array{type: 'file_path', text: string, file_path: array{file_id: string}, start_index: int, end_index: int}>}}>, assistant_id: ?string, run_id: ?string, attachments?: array<int, array{file_id: string, tools: array<int, array{type: 'file_search'}|array{type: 'code_interpreter'}>}>, metadata: array<string, string>}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return ThreadMessageResponse::from($response->data(), $response->meta());
     }
@@ -59,7 +63,9 @@ public function modify(string $threadId, string $messageId, array $parameters):
         $payload = Payload::modify("threads/$threadId/messages", $messageId, $parameters);
 
         /** @var Response<array{id: string, object: string, created_at: int, thread_id: string, role: string, content: array<int, array{type: 'image_url', image_url: array{url: string, detail?: string}}|array{type: 'image_file', image_file: array{file_id: string, detail?: string}}|array{type: 'text', text: array{value: string, annotations: array<int, array{type: 'file_citation', text: string, file_citation: array{file_id: string, quote?: string}, start_index: int, end_index: int}|array{type: 'file_path', text: string, file_path: array{file_id: string}, start_index: int, end_index: int}>}}>, assistant_id: ?string, run_id: ?string, attachments?: array<int, array{file_id: string, tools: array<int, array{type: 'file_search'}|array{type: 'code_interpreter'}>}>, metadata: array<string, string>}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return ThreadMessageResponse::from($response->data(), $response->meta());
     }
@@ -74,7 +80,9 @@ public function delete(string $threadId, string $messageId): ThreadMessageDelete
         $payload = Payload::delete("threads/$threadId/messages", $messageId);
 
         /** @var Response<array{id: string, object: string, deleted: bool}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return ThreadMessageDeleteResponse::from($response->data(), $response->meta());
     }
@@ -91,7 +99,9 @@ public function list(string $threadId, array $parameters = []): ThreadMessageLis
         $payload = Payload::list("threads/$threadId/messages", $parameters);
 
         /** @var Response<array{object: string, data: array<int, array{id: string, object: string, created_at: int, thread_id: string, role: string, content: array<int, array{type: 'image_url', image_url: array{url: string, detail?: string}}|array{type: 'image_file', image_file: array{file_id: string, detail?: string}}|array{type: 'text', text: array{value: string, annotations: array<int, array{type: 'file_citation', text: string, file_citation: array{file_id: string, quote?: string}, start_index: int, end_index: int}|array{type: 'file_path', text: string, file_path: array{file_id: string}, start_index: int, end_index: int}>}}>, assistant_id: ?string, run_id: ?string, attachments?: array<int, array{file_id: string, tools: array<int, array{type: 'file_search'}|array{type: 'code_interpreter'}>}>, metadata: array<string, string>}>, first_id: ?string, last_id: ?string, has_more: bool}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return ThreadMessageListResponse::from($response->data(), $response->meta());
     }