openai 4.16.0 → 4.16.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 4.16.1 (2023-11-06)
+
+Full Changelog: [v4.16.0...v4.16.1](https://github.com/openai/openai-node/compare/v4.16.0...v4.16.1)
+
+### Bug Fixes
+
+* **api:** retreival -> retrieval ([#437](https://github.com/openai/openai-node/issues/437)) ([b4bd3ee](https://github.com/openai/openai-node/commit/b4bd3eefdd3903abcc57c431382cc2124d39307b))
+
+
+### Documentation
+
+* **api:** improve docstrings ([#435](https://github.com/openai/openai-node/issues/435)) ([ee8b24c](https://github.com/openai/openai-node/commit/ee8b24c70a5ccb944e02ff2201668d6bc2b597b3))
+
 ## 4.16.0 (2023-11-06)
 
 Full Changelog: [v4.15.4...v4.16.0](https://github.com/openai/openai-node/compare/v4.15.4...v4.16.0)

package/README.md

@@ -21,7 +21,7 @@ You can import in Deno via:
 <!-- x-release-please-start-version -->
 
 ```ts
-import OpenAI from 'https://deno.land/x/openai@4.15.4/mod.ts';
+import OpenAI from 'https://deno.land/x/openai@4.16.0/mod.ts';
 ```
 
 <!-- x-release-please-end -->

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.16.0",
+  "version": "4.16.1",
   "description": "Client library for the OpenAI API",
   "author": "OpenAI <support@openai.com>",
   "types": "./index.d.ts",

package/resources/beta/assistants/assistants.d.ts

@@ -6,31 +6,31 @@ import { CursorPage, type CursorPageParams } from 'openai/pagination';
 export declare class Assistants extends APIResource {
     files: FilesAPI.Files;
     /**
-     * Create an Assistant with a model and instructions.
+     * Create an assistant with a model and instructions.
      */
     create(body: AssistantCreateParams, options?: Core.RequestOptions): Core.APIPromise<Assistant>;
     /**
-     * Retrieves an Assistant.
+     * Retrieves an assistant.
      */
     retrieve(assistantId: string, options?: Core.RequestOptions): Core.APIPromise<Assistant>;
     /**
-     * Modifies an Assistant.
+     * Modifies an assistant.
      */
     update(assistantId: string, body: AssistantUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Assistant>;
     /**
-     * Returns a list of Assistants.
+     * Returns a list of assistants.
      */
     list(query?: AssistantListParams, options?: Core.RequestOptions): Core.PagePromise<AssistantsPage, Assistant>;
     list(options?: Core.RequestOptions): Core.PagePromise<AssistantsPage, Assistant>;
     /**
-     * Delete an Assistant.
+     * Delete an assistant.
      */
     del(assistantId: string, options?: Core.RequestOptions): Core.APIPromise<AsssitantDeleted>;
 }
 export declare class AssistantsPage extends CursorPage<Assistant> {
 }
 /**
- * Represents an `Assistant` that can call the model and use tools.
+ * Represents an `assistant` that can call the model and use tools.
  */
 export interface Assistant {
     /**
@@ -38,21 +38,21 @@ export interface Assistant {
      */
     id: string;
     /**
-     * The Unix timestamp (in seconds) for when the Assistant was created.
+     * The Unix timestamp (in seconds) for when the assistant was created.
      */
     created_at: number;
     /**
-     * The description of the Assistant. The maximum length is 512 characters.
+     * The description of the assistant. The maximum length is 512 characters.
      */
     description: string | null;
     /**
-     * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs
-     * attached to this Assistant. There can be a maximum of 20 files attached to the
-     * Assistant. Files are ordered by their creation date in ascending order.
+     * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs
+     * attached to this assistant. There can be a maximum of 20 files attached to the
+     * assistant. Files are ordered by their creation date in ascending order.
      */
     file_ids: Array<string>;
     /**
-     * The system instructions that the Assistant uses. The maximum length is 32768
+     * The system instructions that the assistant uses. The maximum length is 32768
      * characters.
      */
     instructions: string | null;
@@ -72,7 +72,7 @@ export interface Assistant {
      */
     model: string;
     /**
-     * The name of the Assistant. The maximum length is 256 characters.
+     * The name of the assistant. The maximum length is 256 characters.
      */
     name: string | null;
     /**
@@ -80,10 +80,10 @@ export interface Assistant {
      */
     object: 'assistant';
     /**
-     * A list of tool enabled on the Assistant. There can be a maximum of 128 tools per
+     * A list of tool enabled on the assistant. There can be a maximum of 128 tools per
      * assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.
      */
-    tools: Array<Assistant.CodeInterpreter | Assistant.Retreival | Assistant.Function>;
+    tools: Array<Assistant.CodeInterpreter | Assistant.Retrieval | Assistant.Function>;
 }
 export declare namespace Assistant {
     interface CodeInterpreter {
@@ -92,11 +92,11 @@ export declare namespace Assistant {
          */
         type: 'code_interpreter';
     }
-    interface Retreival {
+    interface Retrieval {
         /**
-         * The type of tool being defined: `retreival`
+         * The type of tool being defined: `retrieval`
          */
-        type: 'retreival';
+        type: 'retrieval';
     }
     interface Function {
         /**
@@ -152,17 +152,17 @@ export interface AssistantCreateParams {
      */
     model: string;
     /**
-     * The description of the Assistant. The maximum length is 512 characters.
+     * The description of the assistant. The maximum length is 512 characters.
      */
     description?: string | null;
     /**
-     * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs
-     * attached to this Assistant. There can be a maximum of 20 files attached to the
-     * Assistant. Files are ordered by their creation date in ascending order.
+     * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs
+     * attached to this assistant. There can be a maximum of 20 files attached to the
+     * assistant. Files are ordered by their creation date in ascending order.
      */
     file_ids?: Array<string>;
     /**
-     * The system instructions that the Assistant uses. The maximum length is 32768
+     * The system instructions that the assistant uses. The maximum length is 32768
      * characters.
      */
     instructions?: string | null;
@@ -174,11 +174,11 @@ export interface AssistantCreateParams {
      */
     metadata?: unknown | null;
     /**
-     * The name of the Assistant. The maximum length is 256 characters.
+     * The name of the assistant. The maximum length is 256 characters.
      */
     name?: string | null;
     /**
-     * A list of tool enabled on the Assistant. There can be a maximum of 128 tools per
+     * A list of tool enabled on the assistant. There can be a maximum of 128 tools per
      * assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.
      */
     tools?: Array<AssistantCreateParams.AssistantToolsCode | AssistantCreateParams.AssistantToolsRetrieval | AssistantCreateParams.AssistantToolsFunction>;
@@ -192,9 +192,9 @@ export declare namespace AssistantCreateParams {
     }
     interface AssistantToolsRetrieval {
         /**
-         * The type of tool being defined: `retreival`
+         * The type of tool being defined: `retrieval`
          */
-        type: 'retreival';
+        type: 'retrieval';
     }
     interface AssistantToolsFunction {
         /**
@@ -237,19 +237,19 @@ export declare namespace AssistantCreateParams {
 }
 export interface AssistantUpdateParams {
     /**
-     * The description of the Assistant. The maximum length is 512 characters.
+     * The description of the assistant. The maximum length is 512 characters.
      */
     description?: string | null;
     /**
      * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs
-     * attached to this Assistant. There can be a maximum of 20 files attached to the
-     * Assistant. Files are ordered by their creation date in ascending order. If a
+     * attached to this assistant. There can be a maximum of 20 files attached to the
+     * assistant. Files are ordered by their creation date in ascending order. If a
      * file was previosuly attached to the list but does not show up in the list, it
      * will be deleted from the assistant.
      */
     file_ids?: Array<string>;
     /**
-     * The system instructions that the Assistant uses. The maximum length is 32768
+     * The system instructions that the assistant uses. The maximum length is 32768
      * characters.
      */
     instructions?: string | null;
@@ -269,11 +269,11 @@ export interface AssistantUpdateParams {
      */
     model?: string;
     /**
-     * The name of the Assistant. The maximum length is 256 characters.
+     * The name of the assistant. The maximum length is 256 characters.
      */
     name?: string | null;
     /**
-     * A list of tool enabled on the Assistant. There can be a maximum of 128 tools per
+     * A list of tool enabled on the assistant. There can be a maximum of 128 tools per
      * assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.
      */
     tools?: Array<AssistantUpdateParams.AssistantToolsCode | AssistantUpdateParams.AssistantToolsRetrieval | AssistantUpdateParams.AssistantToolsFunction>;
@@ -287,9 +287,9 @@ export declare namespace AssistantUpdateParams {
     }
     interface AssistantToolsRetrieval {
         /**
-         * The type of tool being defined: `retreival`
+         * The type of tool being defined: `retrieval`
          */
-        type: 'retreival';
+        type: 'retrieval';
     }
     interface AssistantToolsFunction {
         /**

package/resources/beta/assistants/assistants.js

@@ -36,7 +36,7 @@ class Assistants extends resource_1.APIResource {
         this.files = new FilesAPI.Files(this.client);
     }
     /**
-     * Create an Assistant with a model and instructions.
+     * Create an assistant with a model and instructions.
      */
     create(body, options) {
         return this.post('/assistants', {
@@ -46,7 +46,7 @@ class Assistants extends resource_1.APIResource {
         });
     }
     /**
-     * Retrieves an Assistant.
+     * Retrieves an assistant.
      */
     retrieve(assistantId, options) {
         return this.get(`/assistants/${assistantId}`, {
@@ -55,7 +55,7 @@ class Assistants extends resource_1.APIResource {
         });
     }
     /**
-     * Modifies an Assistant.
+     * Modifies an assistant.
      */
     update(assistantId, body, options) {
         return this.post(`/assistants/${assistantId}`, {
@@ -75,7 +75,7 @@ class Assistants extends resource_1.APIResource {
         });
     }
     /**
-     * Delete an Assistant.
+     * Delete an assistant.
      */
     del(assistantId, options) {
         return this.delete(`/assistants/${assistantId}`, {

package/resources/beta/assistants/assistants.mjs

@@ -10,7 +10,7 @@ export class Assistants extends APIResource {
         this.files = new FilesAPI.Files(this.client);
     }
     /**
-     * Create an Assistant with a model and instructions.
+     * Create an assistant with a model and instructions.
      */
     create(body, options) {
         return this.post('/assistants', {
@@ -20,7 +20,7 @@ export class Assistants extends APIResource {
         });
     }
     /**
-     * Retrieves an Assistant.
+     * Retrieves an assistant.
      */
     retrieve(assistantId, options) {
         return this.get(`/assistants/${assistantId}`, {
@@ -29,7 +29,7 @@ export class Assistants extends APIResource {
         });
     }
     /**
-     * Modifies an Assistant.
+     * Modifies an assistant.
      */
     update(assistantId, body, options) {
         return this.post(`/assistants/${assistantId}`, {
@@ -49,7 +49,7 @@ export class Assistants extends APIResource {
         });
     }
     /**
-     * Delete an Assistant.
+     * Delete an assistant.
      */
     del(assistantId, options) {
         return this.delete(`/assistants/${assistantId}`, {

package/resources/beta/assistants/files.d.ts

@@ -4,9 +4,9 @@ import * as FilesAPI from 'openai/resources/beta/assistants/files';
 import { CursorPage, type CursorPageParams } from 'openai/pagination';
 export declare class Files extends APIResource {
     /**
-     * Create an Assistant File by attaching a
+     * Create an assistant file by attaching a
      * [File](https://platform.openai.com/docs/api-reference/files) to an
-     * [Assistant](https://platform.openai.com/docs/api-reference/assistants).
+     * [assistant](https://platform.openai.com/docs/api-reference/assistants).
      */
     create(assistantId: string, body: FileCreateParams, options?: Core.RequestOptions): Core.APIPromise<AssistantFile>;
     /**
@@ -14,12 +14,12 @@ export declare class Files extends APIResource {
      */
     retrieve(assistantId: string, fileId: string, options?: Core.RequestOptions): Core.APIPromise<AssistantFile>;
     /**
-     * Returns a list of Assistant Files.
+     * Returns a list of assistant files.
      */
     list(assistantId: string, query?: FileListParams, options?: Core.RequestOptions): Core.PagePromise<AssistantFilesPage, AssistantFile>;
     list(assistantId: string, options?: Core.RequestOptions): Core.PagePromise<AssistantFilesPage, AssistantFile>;
     /**
-     * Delete an Assistant File.
+     * Delete an assistant file.
      */
     del(assistantId: string, fileId: string, options?: Core.RequestOptions): Core.APIPromise<FileDeleteResponse>;
 }
@@ -27,7 +27,7 @@ export declare class AssistantFilesPage extends CursorPage<AssistantFile> {
 }
 /**
  * A list of [Files](https://platform.openai.com/docs/api-reference/files) attached
- * to an `Assistant`.
+ * to an `assistant`.
  */
 export interface AssistantFile {
     /**
@@ -35,11 +35,11 @@ export interface AssistantFile {
      */
     id: string;
     /**
-     * The Assistant ID that the File is attached to.
+     * The assistant ID that the file is attached to.
      */
     assistant_id: string;
     /**
-     * The Unix timestamp (in seconds) for when the Assistant File was created.
+     * The Unix timestamp (in seconds) for when the assistant file was created.
      */
     created_at: number;
     /**
@@ -48,7 +48,7 @@ export interface AssistantFile {
     object: 'assistant.file';
 }
 /**
- * Deletes the association between the Assistant and the File, but does not delete
+ * Deletes the association between the assistant and the file, but does not delete
  * the [File](https://platform.openai.com/docs/api-reference/files) object itself.
  */
 export interface FileDeleteResponse {
@@ -59,7 +59,7 @@ export interface FileDeleteResponse {
 export interface FileCreateParams {
     /**
      * A [File](https://platform.openai.com/docs/api-reference/files) ID (with
-     * `purpose="assistants"`) that the Assistant should use. Useful for tools like
+     * `purpose="assistants"`) that the assistant should use. Useful for tools like
      * `retrieval` and `code_interpreter` that can access files.
      */
     file_id: string;

package/resources/beta/assistants/files.js

@@ -31,9 +31,9 @@ const FilesAPI = __importStar(require("openai/resources/beta/assistants/files"))
 const pagination_1 = require("openai/pagination");
 class Files extends resource_1.APIResource {
     /**
-     * Create an Assistant File by attaching a
+     * Create an assistant file by attaching a
      * [File](https://platform.openai.com/docs/api-reference/files) to an
-     * [Assistant](https://platform.openai.com/docs/api-reference/assistants).
+     * [assistant](https://platform.openai.com/docs/api-reference/assistants).
      */
     create(assistantId, body, options) {
         return this.post(`/assistants/${assistantId}/files`, {
@@ -62,7 +62,7 @@ class Files extends resource_1.APIResource {
         });
     }
     /**
-     * Delete an Assistant File.
+     * Delete an assistant file.
      */
     del(assistantId, fileId, options) {
         return this.delete(`/assistants/${assistantId}/files/${fileId}`, {

package/resources/beta/assistants/files.mjs

@@ -5,9 +5,9 @@ import * as FilesAPI from 'openai/resources/beta/assistants/files';
 import { CursorPage } from 'openai/pagination';
 export class Files extends APIResource {
     /**
-     * Create an Assistant File by attaching a
+     * Create an assistant file by attaching a
      * [File](https://platform.openai.com/docs/api-reference/files) to an
-     * [Assistant](https://platform.openai.com/docs/api-reference/assistants).
+     * [assistant](https://platform.openai.com/docs/api-reference/assistants).
      */
     create(assistantId, body, options) {
         return this.post(`/assistants/${assistantId}/files`, {
@@ -36,7 +36,7 @@ export class Files extends APIResource {
         });
     }
     /**
-     * Delete an Assistant File.
+     * Delete an assistant file.
      */
     del(assistantId, fileId, options) {
         return this.delete(`/assistants/${assistantId}/files/${fileId}`, {

package/resources/beta/threads/messages/files.d.ts

@@ -4,11 +4,11 @@ import * as FilesAPI from 'openai/resources/beta/threads/messages/files';
 import { CursorPage, type CursorPageParams } from 'openai/pagination';
 export declare class Files extends APIResource {
     /**
-     * Retrieves a Message File.
+     * Retrieves a message file.
      */
     retrieve(threadId: string, messageId: string, fileId: string, options?: Core.RequestOptions): Core.APIPromise<MessageFile>;
     /**
-     * Returns a list of Message Files.
+     * Returns a list of message files.
      */
     list(threadId: string, messageId: string, query?: FileListParams, options?: Core.RequestOptions): Core.PagePromise<MessageFilesPage, MessageFile>;
     list(threadId: string, messageId: string, options?: Core.RequestOptions): Core.PagePromise<MessageFilesPage, MessageFile>;
@@ -16,7 +16,7 @@ export declare class Files extends APIResource {
 export declare class MessageFilesPage extends CursorPage<MessageFile> {
 }
 /**
- * A list of Files attached to a `Message`.
+ * A list of files attached to a `message`.
  */
 export interface MessageFile {
     /**
@@ -24,11 +24,11 @@ export interface MessageFile {
      */
     id: string;
     /**
-     * The Unix timestamp (in seconds) for when the Message File was created.
+     * The Unix timestamp (in seconds) for when the message file was created.
      */
     created_at: number;
     /**
-     * The ID of the [Message](https://platform.openai.com/docs/api-reference/messages)
+     * The ID of the [message](https://platform.openai.com/docs/api-reference/messages)
      * that the [File](https://platform.openai.com/docs/api-reference/files) is
      * attached to.
      */

package/resources/beta/threads/messages/files.js

@@ -31,7 +31,7 @@ const FilesAPI = __importStar(require("openai/resources/beta/threads/messages/fi
 const pagination_1 = require("openai/pagination");
 class Files extends resource_1.APIResource {
     /**
-     * Retrieves a Message File.
+     * Retrieves a message file.
      */
     retrieve(threadId, messageId, fileId, options) {
         return this.get(`/threads/${threadId}/messages/${messageId}/files/${fileId}`, {

package/resources/beta/threads/messages/files.mjs

@@ -5,7 +5,7 @@ import * as FilesAPI from 'openai/resources/beta/threads/messages/files';
 import { CursorPage } from 'openai/pagination';
 export class Files extends APIResource {
     /**
-     * Retrieves a Message File.
+     * Retrieves a message file.
      */
     retrieve(threadId, messageId, fileId, options) {
         return this.get(`/threads/${threadId}/messages/${messageId}/files/${fileId}`, {