Fixes before v1.6.0 release

Applies 7cf4d2baeeda1814cf2587b858a7bf7548e32b83..f79505bf31e16decb023c7d0f87577cfc340aa2d

Author: thejamescollins

CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## 1.6.0 - 2023-09-05
+## 1.6.0 - 2023-09-06
 
 ### Added
 - Add support for OpenAI's new **fine-tuning** API, which allows fine-tuning of GPT 3.5 Turbo. [Fine-tuning guide](https://platform.openai.com/docs/guides/fine-tuning). [Announcement](https://openai.com/blog/gpt-3-5-turbo-fine-tuning-and-api-updates).

README.md

@@ -314,7 +314,7 @@ See the table below for a full list of API Handlers and Methods.
 |`Files::create()`|Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.|`POST` `/files`|
 |`Files::retrieve()`|Returns information about a specific file.|`GET` `/files/{file_id}`|
 |`Files::delete()`|Delete a file.|`DELETE` `/files/{file_id}`|
-|`FilesContent::download()`|Returns the contents of the specified file|`GET` `/files/{file_id}/content`|
+|`FilesContent::download()`|Returns the contents of the specified file.|`GET` `/files/{file_id}/content`|
 |~~`FineTunes::list()`~~|~~List your organization's fine-tuning jobs~~|~~`GET` `/fine-tunes`~~|
 |~~`FineTunes::create()`~~|~~Creates a job that fine-tunes a specified model from a given dataset.<br />Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.<br />Learn more about fine-tuning~~|~~`POST` `/fine-tunes`~~|
 |~~`FineTunes::retrieve()`~~|~~Gets info about the fine-tune job.<br />Learn more about fine-tuning~~|~~`GET` `/fine-tunes/{fine_tune_id}`~~|

src/Handlers/Files.php

@@ -98,7 +98,7 @@ public function create($body): self
      * Operation URL: GET /files/{file_id}
      * Operation ID:  retrieveFile
      *
-     * @param string $fileId The ID of the file to use for this request
+     * @param string $fileId The ID of the file to use for this request.
      *
      * @api
      * @return self
@@ -121,7 +121,7 @@ public function retrieve($fileId): self
      * Operation URL: DELETE /files/{file_id}
      * Operation ID:  deleteFile
      *
-     * @param string $fileId The ID of the file to use for this request
+     * @param string $fileId The ID of the file to use for this request.
      *
      * @api
      * @return self

src/Handlers/FilesContent.php

@@ -42,12 +42,12 @@ public function __construct(?Client $client = null)
     }
 
     /**
-     * Returns the contents of the specified file
+     * Returns the contents of the specified file.
      *
      * Operation URL: GET /files/{file_id}/content
      * Operation ID:  downloadFile
      *
-     * @param string $fileId The ID of the file to use for this request
+     * @param string $fileId The ID of the file to use for this request.
      *
      * @api
      * @return self

src/Handlers/FineTuningJobs.php

@@ -103,7 +103,7 @@ public function create($body): self
      * Operation URL: GET /fine_tuning/jobs/{fine_tuning_job_id}
      * Operation ID:  retrieveFineTuningJob
      *
-     * @param string $fineTuningJobId The ID of the fine-tuning job
+     * @param string $fineTuningJobId The ID of the fine-tuning job.
      *
      * @api
      * @return self

src/Handlers/FineTuningJobsCancel.php

@@ -47,7 +47,7 @@ public function __construct(?Client $client = null)
      * Operation URL: POST /fine_tuning/jobs/{fine_tuning_job_id}/cancel
      * Operation ID:  cancelFineTuningJob
      *
-     * @param string $fineTuningJobId The ID of the fine-tuning job to cancel
+     * @param string $fineTuningJobId The ID of the fine-tuning job to cancel.
      *
      * @api
      * @return self

src/Models/FineTuningJobs/CreateResponse.php

@@ -59,9 +59,10 @@ final class CreateResponse extends AbstractModel
     public $created_at;
 
     /**
-     * The Unix timestamp (in seconds) for when the fine-tuning job was finished.
+     * The Unix timestamp (in seconds) for when the fine-tuning job was finished. The
+     * value will be null if the fine-tuning job is still running.
      *
-     * @var int
+     * @var int|null
      */
     public $finished_at;
 
@@ -73,7 +74,8 @@ final class CreateResponse extends AbstractModel
     public $model;
 
     /**
-     * The name of the fine-tuned model that is being created.
+     * The name of the fine-tuned model that is being created. The value will be null
+     * if the fine-tuning job is still running.
      *
      * @var string|null
      */
@@ -103,30 +105,34 @@ final class CreateResponse extends AbstractModel
     public $hyperparameters;
 
     /**
-     * The file ID used for training.
+     * The file ID used for training. You can retrieve the training data with the Files
+     * API.
      *
      * @var string
      */
     public $training_file;
 
     /**
-     * The file ID used for validation.
+     * The file ID used for validation. You can retrieve the validation results with
+     * the Files API.
      *
      * @var string|null
      */
     public $validation_file;
 
     /**
-     * The compiled results files for the fine-tuning job.
+     * The compiled results file ID(s) for the fine-tuning job. You can retrieve the
+     * results with the Files API.
      *
-     * @var \Tectalic\OpenAi\Models\FineTuningJobs\CreateResponseResultFilesItem[]
+     * @var string[]
      */
     public $result_files;
 
     /**
-     * The total number of billable tokens processed by this fine tuning job.
+     * The total number of billable tokens processed by this fine-tuning job. The value
+     * will be null if the fine-tuning job is still running.
      *
-     * @var int
+     * @var int|null
      */
     public $trained_tokens;
 }

src/Models/FineTuningJobs/CreateResponseResultFilesItem.php

@@ -59,9 +59,10 @@ final class ListPaginatedResponseDataItem extends AbstractModel
     public $created_at;
 
     /**
-     * The Unix timestamp (in seconds) for when the fine-tuning job was finished.
+     * The Unix timestamp (in seconds) for when the fine-tuning job was finished. The
+     * value will be null if the fine-tuning job is still running.
      *
-     * @var int
+     * @var int|null
      */
     public $finished_at;
 
@@ -73,7 +74,8 @@ final class ListPaginatedResponseDataItem extends AbstractModel
     public $model;
 
     /**
-     * The name of the fine-tuned model that is being created.
+     * The name of the fine-tuned model that is being created. The value will be null
+     * if the fine-tuning job is still running.
      *
      * @var string|null
      */
@@ -103,30 +105,34 @@ final class ListPaginatedResponseDataItem extends AbstractModel
     public $hyperparameters;
 
     /**
-     * The file ID used for training.
+     * The file ID used for training. You can retrieve the training data with the Files
+     * API.
      *
      * @var string
      */
     public $training_file;
 
     /**
-     * The file ID used for validation.
+     * The file ID used for validation. You can retrieve the validation results with
+     * the Files API.
      *
      * @var string|null
      */
     public $validation_file;
 
     /**
-     * The compiled results files for the fine-tuning job.
+     * The compiled results file ID(s) for the fine-tuning job. You can retrieve the
+     * results with the Files API.
      *
-     * @var \Tectalic\OpenAi\Models\FineTuningJobs\ListPaginatedResponseDataItemResultFilesItem[]
+     * @var string[]
      */
     public $result_files;
 
     /**
-     * The total number of billable tokens processed by this fine tuning job.
+     * The total number of billable tokens processed by this fine-tuning job. The value
+     * will be null if the fine-tuning job is still running.
      *
-     * @var int
+     * @var int|null
      */
     public $trained_tokens;
 }