[WIP] Assistants v2 support

README.md

@@ -942,7 +942,7 @@ $response->toArray(); // ['created' => 1589478378, data => ['url' => 'https://oa
 
 > **Note:** If you are creating the client manually from the factory. Make sure you provide the necessary header:
 > ```php
-> $factory->withHttpHeader('OpenAI-Beta', 'assistants=v1')
+> $factory->withHttpHeader('OpenAI-Beta', 'assistants=v2')
 > ```
 
 #### `create`
@@ -969,8 +969,11 @@ $response->instructions; // 'You are a personal math tutor. When asked a questio
 $response->model; // 'gpt-4'
 $response->description; // null
 $response->tools[0]->type; // 'code_interpreter'
-$response->fileIds; // []
+$response->toolResources; // []
 $response->metadata; // []
+$response->temperature: // null
+$response->topP: // null
+$response->format: // 'auto'
 
 $response->toArray(); // ['id' => 'asst_gxzBkD1wkKEloYqZ410pT5pd', ...]
 ```
@@ -990,8 +993,11 @@ $response->instructions; // 'You are a personal math tutor. When asked a questio
 $response->model; // 'gpt-4'
 $response->description; // null
 $response->tools[0]->type; // 'code_interpreter'
-$response->fileIds; // []
+$response->toolResources; // []
 $response->metadata; // []
+$response->temperature: // null
+$response->topP: // null
+$response->format: // 'auto'
 
 $response->toArray(); // ['id' => 'asst_gxzBkD1wkKEloYqZ410pT5pd', ...]
 ```
@@ -1013,8 +1019,11 @@ $response->instructions; // 'You are a personal math tutor. When asked a questio
 $response->model; // 'gpt-4'
 $response->description; // null
 $response->tools[0]->type; // 'code_interpreter'
-$response->fileIds; // []
+$response->toolResources; // []
 $response->metadata; // []
+$response->temperature: // null
+$response->topP: // null
+$response->format: // 'auto'
 
 $response->toArray(); // ['id' => 'asst_gxzBkD1wkKEloYqZ410pT5pd', ...]
 ```
@@ -1055,7 +1064,7 @@ foreach ($response->data as $result) {
 $response->toArray(); // ['object' => 'list', ...]]
 ```
 
-### `Assistants Files` Resource
+### `Assistants Files` Resource [Deprecated]
 
 #### `create`
 
@@ -1183,8 +1192,16 @@ $response->lastError; // null
 $response->model; // 'gpt-4'
 $response->instructions; // null
 $response->tools; // []
-$response->fileIds; // []
 $response->metadata; // []
+$response->incompleteDetails; // []
+$response->usage?->total_tokens; // 579
+$response->temperature; // null
+$response->topP; // null
+$response->maxPromptTokens; // 1000
+$response->maxCompletionTokens; // 1000
+$response->truncationStrategy->type; // 'auto'
+$response->responseFormat; // 'auto'
+$response->toolChoice; // 'auto'
 
 $response->toArray(); // ['id' => 'run_4RCYyYzX9m41WQicoJtUQAb8', ...]
 ```
@@ -1259,7 +1276,7 @@ $response->content[0]->text->value; // 'What is the sum of 5 and 7?'
 $response->content[0]->text->annotations; // []
 $response->assistantId; // null
 $response->runId; // null
-$response->fileIds; // []
+$response->attachments; // []
 $response->metadata; // []
 
 $response->toArray(); // ['id' => 'msg_SKYwvF3zcigxthfn6F4hnpdU', ...]
@@ -1285,7 +1302,7 @@ $response->content[0]->text->value; // 'What is the sum of 5 and 7?'
 $response->content[0]->text->annotations; // []
 $response->assistantId; // null
 $response->runId; // null
-$response->fileIds; // []
+$response->attachments; // []
 $response->metadata; // []
 
 $response->toArray(); // ['id' => 'msg_SKYwvF3zcigxthfn6F4hnpdU', ...]
@@ -1316,7 +1333,7 @@ $response->content[0]->text->value; // 'What is the sum of 5 and 7?'
 $response->content[0]->text->annotations; // []
 $response->assistantId; // null
 $response->runId; // null
-$response->fileIds; // []
+$response->attachments; // []
 $response->metadata; // ['name' => 'My new message name']
 
 $response->toArray(); // ['id' => 'msg_SKYwvF3zcigxthfn6F4hnpdU', ...]
@@ -1344,7 +1361,7 @@ foreach ($response->data as $result) {
 $response->toArray(); // ['object' => 'list', ...]]
 ```
 
-### `Threads Messages Files` Resource
+### `Threads Messages Files` Resource [Deprecated]
 
 #### `retrieve`
 
@@ -1419,9 +1436,17 @@ $response->completedAt; // null
 $response->lastError; // null
 $response->model; // 'gpt-4'
 $response->instructions; // null
-$response->tools[0]->type; // 'code_interpreter'
-$response->fileIds; // []
+$response->tools; // []
 $response->metadata; // []
+$response->incompleteDetails; // []
+$response->usage?->total_tokens; // 579
+$response->temperature; // null
+$response->topP; // null
+$response->maxPromptTokens; // 1000
+$response->maxCompletionTokens; // 1000
+$response->truncationStrategy->type; // 'auto'
+$response->responseFormat; // 'auto'
+$response->toolChoice; // 'auto'
 
 $response->toArray(); // ['id' => 'run_4RCYyYzX9m41WQicoJtUQAb8', ...]
 ```
@@ -1526,13 +1551,19 @@ $response->completedAt; // null
 $response->lastError; // null
 $response->model; // 'gpt-4'
 $response->instructions; // null
-$response->tools[0]->type; // 'code_interpreter'
-$response->fileIds; // []
+$response->tools; // []
 $response->metadata; // []
-
+$response->incompleteDetails; // []
 $response->usage->promptTokens; // 25,
 $response->usage->completionTokens; // 32,
 $response->usage->totalTokens; // 57
+$response->temperature; // null
+$response->topP; // null
+$response->maxPromptTokens; // 1000
+$response->maxCompletionTokens; // 1000
+$response->truncationStrategy->type; // 'auto'
+$response->responseFormat; // 'auto'
+$response->toolChoice; // 'auto'
 
 $response->toArray(); // ['id' => 'run_4RCYyYzX9m41WQicoJtUQAb8', ...]
 ```
@@ -1566,8 +1597,16 @@ $response->completedAt; // null
 $response->lastError; // null
 $response->model; // 'gpt-4'
 $response->instructions; // null
-$response->tools[0]->type; // 'code_interpreter'
-$response->fileIds; // []
+$response->tools; // []
+$response->incompleteDetails; // []
+$response->usage?->total_tokens; // 579
+$response->temperature; // null
+$response->topP; // null
+$response->maxPromptTokens; // 1000
+$response->maxCompletionTokens; // 1000
+$response->truncationStrategy->type; // 'auto'
+$response->responseFormat; // 'auto'
+$response->toolChoice; // 'auto'
 $response->metadata; // ['name' => 'My new run name']
 
 $response->toArray(); // ['id' => 'run_4RCYyYzX9m41WQicoJtUQAb8', ...]
@@ -1597,8 +1636,16 @@ $response->completedAt; // null
 $response->lastError; // null
 $response->model; // 'gpt-4'
 $response->instructions; // null
-$response->tools[0]->type; // 'code_interpreter'
-$response->fileIds; // []
+$response->tools; // []
+$response->incompleteDetails; // []
+$response->usage?->total_tokens; // 579
+$response->temperature; // null
+$response->topP; // null
+$response->maxPromptTokens; // 1000
+$response->maxCompletionTokens; // 1000
+$response->truncationStrategy->type; // 'auto'
+$response->responseFormat; // 'auto'
+$response->toolChoice; // 'auto'
 $response->metadata; // []
 
 $response->toArray(); // ['id' => 'run_4RCYyYzX9m41WQicoJtUQAb8', ...]
@@ -1636,8 +1683,16 @@ $response->completedAt; // null
 $response->lastError; // null
 $response->model; // 'gpt-4'
 $response->instructions; // null
+$response->incompleteDetails; // []
+$response->usage?->total_tokens; // 579
+$response->temperature; // null
+$response->topP; // null
+$response->maxPromptTokens; // 1000
+$response->maxCompletionTokens; // 1000
+$response->truncationStrategy->type; // 'auto'
+$response->responseFormat; // 'auto'
+$response->toolChoice; // 'auto'
 $response->tools[0]->type; // 'function'
-$response->fileIds; // []
 $response->metadata; // []
 
 $response->toArray(); // ['id' => 'run_4RCYyYzX9m41WQicoJtUQAb8', ...]

src/Client.php

@@ -6,6 +6,7 @@
 
 use OpenAI\Contracts\ClientContract;
 use OpenAI\Contracts\Resources\ThreadsContract;
+use OpenAI\Contracts\Resources\VectorStoresContract;
 use OpenAI\Contracts\TransporterContract;
 use OpenAI\Resources\Assistants;
 use OpenAI\Resources\Audio;
@@ -20,6 +21,7 @@
 use OpenAI\Resources\Models;
 use OpenAI\Resources\Moderations;
 use OpenAI\Resources\Threads;
+use OpenAI\Resources\VectorStores;
 
 final class Client implements ClientContract
 {
@@ -163,4 +165,14 @@ public function threads(): ThreadsContract
     {
         return new Threads($this->transporter);
     }
+
+    /**
+     * Create and update vector stores that assistants can interact with
+     *
+     * @see https://platform.openai.com/docs/api-reference/vector-stores
+     */
+    public function vectorStores(): VectorStoresContract
+    {
+        return new VectorStores($this->transporter);
+    }
 }

src/Contracts/ClientContract.php

@@ -15,6 +15,7 @@
 use OpenAI\Contracts\Resources\ModelsContract;
 use OpenAI\Contracts\Resources\ModerationsContract;
 use OpenAI\Contracts\Resources\ThreadsContract;
+use OpenAI\Contracts\Resources\VectorStoresContract;
 
 interface ClientContract
 {
@@ -113,4 +114,11 @@ public function assistants(): AssistantsContract;
      * @see https://platform.openai.com/docs/api-reference/threads
      */
     public function threads(): ThreadsContract;
+
+    /**
+     * Create and update vector stores that assistants can interact with
+     *
+     * @see https://platform.openai.com/docs/api-reference/vector-stores
+     */
+    public function vectorStores(): VectorStoresContract;
 }

src/Contracts/Resources/VectorStoresContract.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace OpenAI\Contracts\Resources;
+
+use OpenAI\Responses\VectorStores\VectorStoreDeleteResponse;
+use OpenAI\Responses\VectorStores\VectorStoreListResponse;
+use OpenAI\Responses\VectorStores\VectorStoreResponse;
+
+interface VectorStoresContract
+{
+    /**
+     * Modify a vector store
+     *
+     * @see https://platform.openai.com/docs/api-reference/vector-stores/modify
+     *
+     * @param  array<string, mixed>  $parameters
+     */
+    public function modify(string $vectorStore, array $parameters): VectorStoreResponse;
+
+    /**
+     * Retrieves a vector store.
+     *
+     * @see https://platform.openai.com/docs/api-reference/vector-stores/retrieve
+     */
+    public function retrieve(string $vectorStore): VectorStoreResponse;
+
+    /**
+     * Delete a vector store.
+     *
+     * https://platform.openai.com/docs/api-reference/vector-stores/delete
+     */
+    public function delete(string $vectorStore): VectorStoreDeleteResponse;
+
+    /**
+     * Create a vector store
+     *
+     * @see https://platform.openai.com/docs/api-reference/vector-stores/create
+     *
+     * @param  array<string, mixed>  $parameters
+     */
+    public function create(array $parameters): VectorStoreResponse;
+
+    /**
+     * Returns a list of vector stores.
+     *
+     * @see https://platform.openai.com/docs/api-reference/vector-stores/list
+     */
+    public function list(): VectorStoreListResponse;
+
+    /**
+     * Manage the files related to the vector store
+     *
+     * @see https://platform.openai.com/docs/api-reference/vector-stores-files
+     */
+    public function files(): VectorStoresFilesContract;
+
+    /**
+     * Manage the file batches related to the vector store
+     *
+     * @see https://platform.openai.com/docs/api-reference/vector-stores-file-batches
+     */
+    public function batches(): VectorStoresFileBatchesContract;
+}

src/Contracts/Resources/VectorStoresFileBatchesContract.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace OpenAI\Contracts\Resources;
+
+use OpenAI\Responses\VectorStores\FileBatches\VectorStoreFileBatchResponse;
+use OpenAI\Responses\VectorStores\Files\VectorStoreFileListResponse;
+
+interface VectorStoresFileBatchesContract
+{
+    /**
+     * Retrieves a file batch within a vector store.
+     *
+     * @see https://platform.openai.com/docs/api-reference/vector-stores-file-batches/getBatch
+     */
+    public function retrieve(string $vectorStoreId, string $fileBatchId): VectorStoreFileBatchResponse;
+
+    /**
+     * Cancel a vector store file batch
+     *
+     * @see https://platform.openai.com/docs/api-reference/vector-stores-file-batches/cancelBatch
+     */
+    public function cancel(string $vectorStoreId, string $fileBatchId): VectorStoreFileBatchResponse;
+
+    /**
+     * Create a file batch on a vector store
+     *
+     * @see https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch
+     *
+     * @param  array<string, mixed>  $parameters
+     */
+    public function create(string $vectorStoreId, array $parameters): VectorStoreFileBatchResponse;
+
+    /**
+     * Lists the files within a file batch within a vector store
+     *
+     * @see https://platform.openai.com/docs/api-reference/vector-stores-file-batches/listBatchFiles
+     */
+    public function listFiles(string $vectorStoreId, string $fileBatchId): VectorStoreFileListResponse;
+}