docs(api): improve docstrings (#435)

openai · Nov 6, 2023 · ee8b24c · ee8b24c
1 parent d4d4687
commit ee8b24c
Show file tree

Hide file tree

Showing 10 changed files with 186 additions and 186 deletions.
diff --git a/README.md b/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 -->

diff --git a/build-deno b/build-deno
@@ -15,7 +15,7 @@ This is a build produced from https://github.com/openai/openai-node – please g
 Usage:
 
 \`\`\`ts
-import OpenAI from "$(echo 'https://deno.land/x/openai@4.15.4/mod.ts' | sed -E s/@\.+\\//@"$PACKAGE_VERSION"\\//)";
+import OpenAI from "$(echo 'https://deno.land/x/openai@4.16.0/mod.ts' | sed -E s/@\.+\\//@"$PACKAGE_VERSION"\\//)";
 
 const client = new OpenAI();
 \`\`\`

diff --git a/src/resources/beta/assistants/assistants.ts b/src/resources/beta/assistants/assistants.ts
@@ -11,7 +11,7 @@ export class Assistants extends APIResource {
   files: FilesAPI.Files = new FilesAPI.Files(this.client);
 
   /**
-   * 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> {
     return this.post('/assistants', {
@@ -22,7 +22,7 @@ export class Assistants extends APIResource {
   }
 
   /**
-   * Retrieves an Assistant.
+   * Retrieves an assistant.
    */
   retrieve(assistantId: string, options?: Core.RequestOptions): Core.APIPromise<Assistant> {
     return this.get(`/assistants/${assistantId}`, {
@@ -32,7 +32,7 @@ export class Assistants extends APIResource {
   }
 
   /**
-   * Modifies an Assistant.
+   * Modifies an assistant.
    */
   update(
     assistantId: string,
@@ -47,7 +47,7 @@ export class Assistants extends APIResource {
   }
 
   /**
-   * Returns a list of Assistants.
+   * Returns a list of assistants.
    */
   list(
     query?: AssistantListParams,
@@ -69,7 +69,7 @@ export class Assistants extends APIResource {
   }
 
   /**
-   * Delete an Assistant.
+   * Delete an assistant.
    */
   del(assistantId: string, options?: Core.RequestOptions): Core.APIPromise<AsssitantDeleted> {
     return this.delete(`/assistants/${assistantId}`, {
@@ -82,7 +82,7 @@ export class Assistants extends APIResource {
 export 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 {
   /**
@@ -91,24 +91,24 @@ 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;
@@ -131,7 +131,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;
 
@@ -141,7 +141,7 @@ 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>;
@@ -225,19 +225,19 @@ 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;
@@ -251,12 +251,12 @@ 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<
@@ -327,21 +327,21 @@ export 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;
@@ -364,12 +364,12 @@ 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<

diff --git a/src/resources/beta/assistants/files.ts b/src/resources/beta/assistants/files.ts
@@ -8,9 +8,9 @@ import { CursorPage, type CursorPageParams } 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: string,
@@ -39,7 +39,7 @@ export class Files extends APIResource {
   }
 
   /**
-   * Returns a list of Assistant Files.
+   * Returns a list of assistant files.
    */
   list(
     assistantId: string,
@@ -66,7 +66,7 @@ export class Files extends APIResource {
   }
 
   /**
-   * Delete an Assistant File.
+   * Delete an assistant file.
    */
   del(
     assistantId: string,
@@ -84,7 +84,7 @@ export 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 {
   /**
@@ -93,12 +93,12 @@ 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;
 
@@ -109,7 +109,7 @@ export interface AssistantFile {
 }
 
 /**
- * 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 {
@@ -123,7 +123,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;

diff --git a/src/resources/beta/threads/messages/files.ts b/src/resources/beta/threads/messages/files.ts
@@ -8,7 +8,7 @@ import { CursorPage, type CursorPageParams } from 'openai/pagination';
 
 export class Files extends APIResource {
   /**
-   * Retrieves a Message File.
+   * Retrieves a message file.
    */
   retrieve(
     threadId: string,
@@ -23,7 +23,7 @@ export class Files extends APIResource {
   }
 
   /**
-   * Returns a list of Message Files.
+   * Returns a list of message files.
    */
   list(
     threadId: string,
@@ -56,7 +56,7 @@ export class Files extends APIResource {
 export class MessageFilesPage extends CursorPage<MessageFile> {}
 
 /**
- * A list of Files attached to a `Message`.
+ * A list of files attached to a `message`.
  */
 export interface MessageFile {
   /**
@@ -65,12 +65,12 @@ 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.
    */