v1.5.0

CHANGELOG.md

@@ -5,6 +5,22 @@ 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.5.0 - 2023-06-19
+
+### Added
+- Add support for **Function Calling** in the chat completions handler. [Function calling guide](https://platform.openai.com/docs/guides/gpt/function-calling).
+
+### Changed
+- The `\Tectalic\OpenAi\Models\Completions\CreateRequest::$prompt` property is now required.
+- The `\Tectalic\OpenAi\Models\Completions\CreateResponseChoicesItem::$text` property is now required.
+- The `\Tectalic\OpenAi\Models\Completions\CreateResponseChoicesItem::$index` property is now required.
+- The `\Tectalic\OpenAi\Models\Completions\CreateResponseChoicesItem::$logprobs` property is now required.
+- The `\Tectalic\OpenAi\Models\Completions\CreateResponseChoicesItem::$finish_reason` property is now required.
+- The `\Tectalic\OpenAi\Models\ChatCompletions\CreateRequestMessagesItem::$content` property is no longer marked as required, as it is not required for `function` chats but is for all other types.
+- Document the valid values for the `\Tectalic\OpenAi\Models\Completions\CreateResponseChoicesItem::$finish_reason` property.
+- Document the valid values for the `\Tectalic\OpenAi\Models\ChatCompletions\CreateResponseChoicesItem::$finish_reason` property.
+- API version updated from 1.2.0 to 1.3.1.
+
 ## 1.4.0 - 2023-03-02
 
 ### Added

README.md

@@ -242,8 +242,8 @@ See the table below for a full list of API Handlers and Methods.
 | --------------------------------- | ----------- | ---------------- |
 |`AudioTranscriptions::create()`|Transcribes audio into the input language.|`POST` `/audio/transcriptions`|
 |`AudioTranslations::create()`|Translates audio into into English.|`POST` `/audio/translations`|
-|`ChatCompletions::create()`|Creates a completion for the chat message|`POST` `/chat/completions`|
-|`Completions::create()`|Creates a completion for the provided prompt and parameters|`POST` `/completions`|
+|`ChatCompletions::create()`|Creates a model response for the given chat conversation.|`POST` `/chat/completions`|
+|`Completions::create()`|Creates a completion for the provided prompt and parameters.|`POST` `/completions`|
 |`Edits::create()`|Creates a new edit for the provided input, instruction, and parameters.|`POST` `/edits`|
 |`Embeddings::create()`|Creates an embedding vector representing the input text.|`POST` `/embeddings`|
 |`Files::list()`|Returns a list of files that belong to the user's organization.|`GET` `/files`|

manifest.json

@@ -1,5 +1,5 @@
 {
- "libraryVersion": "1.4.0",
- "apiVersion": "1.2.0",
+ "libraryVersion": "1.5.0",
+ "apiVersion": "1.3.1",
  "buildVersion": "1.2.1"
 }

src/Client.php

@@ -72,25 +72,25 @@ public function __construct(ClientInterface $httpClient, Authentication $auth, s
  }
 
  /**
- * Access to the completions handler.
+ * Access to the chatCompletions handler.
  *
  * @api
- * @return Completions
+ * @return ChatCompletions
  */
- public function completions(): Completions
+ public function chatCompletions(): ChatCompletions
  {
- return new \Tectalic\OpenAi\Handlers\Completions($this);
+ return new \Tectalic\OpenAi\Handlers\ChatCompletions($this);
  }
 
  /**
- * Access to the chatCompletions handler.
+ * Access to the completions handler.
  *
  * @api
- * @return ChatCompletions
+ * @return Completions
  */
- public function chatCompletions(): ChatCompletions
+ public function completions(): Completions
  {
- return new \Tectalic\OpenAi\Handlers\ChatCompletions($this);
+ return new \Tectalic\OpenAi\Handlers\Completions($this);
  }
 
  /**
@@ -406,7 +406,7 @@ private function mergeRequestParts(
 
  $request = $request->withHeader(
  'User-Agent',
- 'Tectalic OpenAI REST API Client/1.4.0'
+ 'Tectalic OpenAI REST API Client/1.5.0'
  );
 
  // Merge Headers.

src/Handlers/ChatCompletions.php

@@ -43,7 +43,7 @@ public function __construct(?Client $client = null)
  }
 
  /**
- * Creates a completion for the chat message
+ * Creates a model response for the given chat conversation.
  *
  * Operation URL: POST /chat/completions
  * Operation ID: createChatCompletion

src/Handlers/Completions.php

@@ -43,7 +43,7 @@ public function __construct(?Client $client = null)
  }
 
  /**
- * Creates a completion for the provided prompt and parameters
+ * Creates a completion for the provided prompt and parameters.
  *
  * Operation URL: POST /completions
  * Operation ID: createCompletion

src/Models/AudioTranscriptions/CreateRequest.php

@@ -30,8 +30,8 @@ final class CreateRequest extends AbstractModel
  protected $ignoreMissing = false;
 
  /**
- * The audio file to transcribe, in one of these formats: mp3, mp4, mpeg, mpga,
- * m4a, wav, or webm.
+ * The audio file object (not file name) to transcribe, in one of these formats:
+ * mp3, mp4, mpeg, mpga, m4a, wav, or webm.
  *
  * @var string must be an absolute path to a file.
  */

src/Models/AudioTranslations/CreateRequest.php

@@ -30,8 +30,8 @@ final class CreateRequest extends AbstractModel
  protected $ignoreMissing = false;
 
  /**
- * The audio file to translate, in one of these formats: mp3, mp4, mpeg, mpga, m4a,
- * wav, or webm.
+ * The audio file object (not file name) translate, in one of these formats: mp3,
+ * mp4, mpeg, mpga, m4a, wav, or webm.
  *
  * @var string must be an absolute path to a file.
  */

src/Models/ChatCompletions/CreateRequest.php

@@ -24,20 +24,39 @@ final class CreateRequest extends AbstractModel
  protected const REQUIRED = ['model', 'messages'];
 
  /**
- * ID of the model to use. Currently, only gpt-3.5-turbo and gpt-3.5-turbo-0301 are
- * supported.
+ * ID of the model to use. See the model endpoint compatibility table for details
+ * on which models work with the Chat API.
  *
  * @var string
  */
  public $model;
 
  /**
- * The messages to generate chat completions for, in the chat format.
+ * A list of messages comprising the conversation so far. Example Python code.
  *
  * @var \Tectalic\OpenAi\Models\ChatCompletions\CreateRequestMessagesItem[]
  */
  public $messages;
 
+ /**
+ * A list of functions the model may generate JSON inputs for.
+ *
+ * @var \Tectalic\OpenAi\Models\ChatCompletions\CreateRequestFunctionsItem[]
+ */
+ public $functions;
+
+ /**
+ * Controls how the model responds to function calls. "none" means the model does
+ * not call a function, and responds to the end-user. "auto" means the model can
+ * pick between an end-user or calling a function. Specifying a particular
+ * function via {"name":\ "my_function"} forces the model to call that function.
+ * "none" is the default when no functions are present. "auto" is the default if
+ * functions are present.
+ *
+ * @var mixed
+ */
+ public $function_call;
+
  /**
  * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
  * make the output more random, while lower values like 0.2 will make it more
@@ -80,7 +99,7 @@ final class CreateRequest extends AbstractModel
  /**
  * If set, partial message deltas will be sent, like in ChatGPT. Tokens will be
  * sent as data-only server-sent events as they become available, with the stream
- * terminated by a data: [DONE] message.
+ * terminated by a data: [DONE] message. Example Python code.
  *
  * Default Value: false
  *
@@ -98,8 +117,9 @@ final class CreateRequest extends AbstractModel
  public $stop;
 
  /**
- * The maximum number of tokens allowed for the generated answer. By default, the
- * number of tokens the model can return will be (4096 - prompt tokens).
+ * The maximum number of tokens to generate in the chat completion.
+ * The total length of input tokens and generated tokens is limited by the model's
+ * context length. Example Python code for counting tokens.
  *
  * @var int
  */

src/Models/ChatCompletions/CreateRequestFunctionsItem.php

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * Copyright (c) 2022-present Tectalic (https://tectalic.com)
+ *
+ * For copyright and license information, please view the LICENSE file that was distributed with this source code.
+ *
+ * Please see the README.md file for usage instructions.
+ */
+
+declare(strict_types=1);
+
+namespace Tectalic\OpenAi\Models\ChatCompletions;
+
+use Tectalic\OpenAi\Models\AbstractModel;
+
+final class CreateRequestFunctionsItem extends AbstractModel
+{
+ /**
+ * List of required property names.
+ *
+ * These properties must all be set when this Model is instantiated.
+ */
+ protected const REQUIRED = ['name'];
+
+ /**
+ * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
+ * underscores and dashes, with a maximum length of 64.
+ *
+ * @var string
+ */
+ public $name;
+
+ /**
+ * The description of what the function does.
+ *
+ * @var string
+ */
+ public $description;
+
+ /**
+ * The parameters the functions accepts, described as a JSON Schema object. See the
+ * guide for examples, and the JSON Schema reference for documentation about the
+ * format.
+ *
+ * @var \Tectalic\OpenAi\Models\ChatCompletions\CreateRequestFunctionsItemParameters
+ */
+ public $parameters;
+}

src/Models/ChatCompletions/CreateRequestFunctionsItemParameters.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * Copyright (c) 2022-present Tectalic (https://tectalic.com)
+ *
+ * For copyright and license information, please view the LICENSE file that was distributed with this source code.
+ *
+ * Please see the README.md file for usage instructions.
+ */
+
+declare(strict_types=1);
+
+namespace Tectalic\OpenAi\Models\ChatCompletions;
+
+use Tectalic\OpenAi\Models\UnstructuredModel;
+
+final class CreateRequestFunctionsItemParameters extends UnstructuredModel
+{
+}

src/Models/ChatCompletions/CreateRequestMessagesItem.php

@@ -21,28 +21,39 @@ final class CreateRequestMessagesItem extends AbstractModel
  *
  * These properties must all be set when this Model is instantiated.
  */
- protected const REQUIRED = ['role', 'content'];
+ protected const REQUIRED = ['role'];
 
  /**
- * The role of the author of this message.
+ * The role of the messages author. One of system, user, assistant, or function.
  *
- * Allowed values: 'system', 'user', 'assistant'
+ * Allowed values: 'system', 'user', 'assistant', 'function'
  *
  * @var string
  */
  public $role;
 
  /**
- * The contents of the message
+ * The contents of the message. content is required for all messages except
+ * assistant messages with function calls.
  *
  * @var string
  */
  public $content;
 
  /**
- * The name of the user in a multi-user chat
+ * The name of the author of this message. name is required if role is function,
+ * and it should be the name of the function whose response is in the content. May
+ * contain a-z, A-Z, 0-9, and underscores, with a maximum length of 64 characters.
  *
  * @var string
  */
  public $name;
+
+ /**
+ * The name and arguments of a function that should be called, as generated by the
+ * model.
+ *
+ * @var \Tectalic\OpenAi\Models\ChatCompletions\CreateRequestMessagesItemFunctionCall
+ */
+ public $function_call;
 }

src/Models/ChatCompletions/CreateRequestMessagesItemFunctionCall.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * Copyright (c) 2022-present Tectalic (https://tectalic.com)
+ *
+ * For copyright and license information, please view the LICENSE file that was distributed with this source code.
+ *
+ * Please see the README.md file for usage instructions.
+ */
+
+declare(strict_types=1);
+
+namespace Tectalic\OpenAi\Models\ChatCompletions;
+
+use Tectalic\OpenAi\Models\AbstractModel;
+
+final class CreateRequestMessagesItemFunctionCall extends AbstractModel
+{
+ /**
+ * The name of the function to call.
+ *
+ * @var string
+ */
+ public $name;
+
+ /**
+ * The arguments to call the function with, as generated by the model in JSON
+ * format. Note that the model does not always generate valid JSON, and may
+ * hallucinate parameters not defined by your function schema. Validate the
+ * arguments in your code before calling your function.
+ *
+ * @var string
+ */
+ public $arguments;
+}

src/Models/ChatCompletions/CreateResponseChoicesItem.php

@@ -22,6 +22,10 @@ final class CreateResponseChoicesItem extends AbstractModel
  /** @var \Tectalic\OpenAi\Models\ChatCompletions\CreateResponseChoicesItemMessage */
  public $message;
 
- /** @var string */
+ /**
+ * Allowed values: 'stop', 'length', 'function_call'
+ *
+ * @var string
+ */
  public $finish_reason;
 }

src/Models/ChatCompletions/CreateResponseChoicesItemMessage.php

@@ -21,21 +21,29 @@ final class CreateResponseChoicesItemMessage extends AbstractModel
  *
  * These properties must all be set when this Model is instantiated.
  */
- protected const REQUIRED = ['role', 'content'];
+ protected const REQUIRED = ['role'];
 
  /**
  * The role of the author of this message.
  *
- * Allowed values: 'system', 'user', 'assistant'
+ * Allowed values: 'system', 'user', 'assistant', 'function'
  *
  * @var string
  */
  public $role;
 
  /**
- * The contents of the message
+ * The contents of the message.
  *
- * @var string
+ * @var string|null
  */
  public $content;
+
+ /**
+ * The name and arguments of a function that should be called, as generated by the
+ * model.
+ *
+ * @var \Tectalic\OpenAi\Models\ChatCompletions\CreateResponseChoicesItemMessageFunctionCall
+ */
+ public $function_call;
 }