SDK regeneration (#152)

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
cohere-ai · Apr 16, 2024 · 2385563 · 2385563
1 parent 40c146c
commit 2385563
Show file tree

Hide file tree

Showing 107 changed files with 1,472 additions and 593 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,13 +1,3 @@
 node_modules
 .DS_Store
-/dist
-/Client.d.ts
-/Client.js
-/environments.d.ts
-/environments.js
-/index.d.ts
-/index.js
-/api
-/core
-/errors
-/serialization
+/dist
diff --git a/package.json b/package.json
@@ -1,15 +1,14 @@
 {
     "name": "cohere-ai",
-    "version": "7.9.3",
+    "version": "7.9.4",
     "private": false,
     "repository": "https://github.com/cohere-ai/cohere-typescript",
     "main": "./index.js",
     "types": "./index.d.ts",
     "scripts": {
-        "format": "prettier --write 'src/**/*.ts'",
+        "format": "prettier . --write --ignore-unknown",
         "build": "tsc",
-        "prepack": "cp -rv dist/. .",
-        "test": "jest"
+        "prepack": "cp -rv dist/. ."
     },
     "dependencies": {
         "url-join": "4.0.1",
@@ -22,11 +21,10 @@
         "@types/url-join": "4.0.1",
         "@types/qs": "6.9.8",
         "@types/node-fetch": "2.6.9",
-        "jest": "^29.7.0",
-        "@types/jest": "^29.5.5",
-        "ts-jest": "^29.1.2",
         "@types/node": "17.0.33",
         "prettier": "2.7.1",
-        "typescript": "4.6.4"
+        "typescript": "4.6.4",
+        "jest": "^29.7.0",
+        "ts-jest": "^29.1.2"
     }
-}
+}
diff --git a/src/Client.ts b/src/Client.ts
@@ -53,13 +53,17 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.9.3",
+                "X-Fern-SDK-Version": "7.9.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
             body: {
-                ...(await serializers.ChatStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "passthrough" })),
+                ...(await serializers.ChatStreamRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                })),
                 stream: true,
             },
             responseType: "streaming",
@@ -147,13 +151,17 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.9.3",
+                "X-Fern-SDK-Version": "7.9.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
             body: {
-                ...(await serializers.ChatRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "passthrough" })),
+                ...(await serializers.ChatRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                })),
                 stream: false,
             },
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 300000,
@@ -221,13 +229,17 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.9.3",
+                "X-Fern-SDK-Version": "7.9.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
             body: {
-                ...(await serializers.GenerateStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "passthrough" })),
+                ...(await serializers.GenerateStreamRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                })),
                 stream: true,
             },
             responseType: "streaming",
@@ -316,13 +328,17 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.9.3",
+                "X-Fern-SDK-Version": "7.9.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
             body: {
-                ...(await serializers.GenerateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "passthrough" })),
+                ...(await serializers.GenerateRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                })),
                 stream: false,
             },
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 300000,
@@ -378,6 +394,15 @@ export class CohereClient {
      * @throws {@link Cohere.BadRequestError}
      * @throws {@link Cohere.TooManyRequestsError}
      * @throws {@link Cohere.InternalServerError}
+     *
+     * @example
+     *     await cohere.embed({
+     *         texts: ["string"],
+     *         model: "string",
+     *         inputType: Cohere.EmbedInputType.SearchDocument,
+     *         embeddingTypes: [Cohere.EmbeddingType.Float],
+     *         truncate: Cohere.EmbedRequestTruncate.None
+     *     })
      */
     public async embed(
         request: Cohere.EmbedRequest,
@@ -397,12 +422,16 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.9.3",
+                "X-Fern-SDK-Version": "7.9.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
-            body: await serializers.EmbedRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "passthrough" }),
+            body: await serializers.EmbedRequest.jsonOrThrow(request, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+            }),
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 300000,
             maxRetries: requestOptions?.maxRetries,
         });
@@ -476,12 +505,16 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.9.3",
+                "X-Fern-SDK-Version": "7.9.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
-            body: await serializers.RerankRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "passthrough" }),
+            body: await serializers.RerankRequest.jsonOrThrow(request, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+            }),
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 300000,
             maxRetries: requestOptions?.maxRetries,
         });
@@ -584,12 +617,16 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.9.3",
+                "X-Fern-SDK-Version": "7.9.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
-            body: await serializers.ClassifyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "passthrough" }),
+            body: await serializers.ClassifyRequest.jsonOrThrow(request, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+            }),
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 300000,
             maxRetries: requestOptions?.maxRetries,
         });
@@ -665,12 +702,16 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.9.3",
+                "X-Fern-SDK-Version": "7.9.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
-            body: await serializers.SummarizeRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "passthrough" }),
+            body: await serializers.SummarizeRequest.jsonOrThrow(request, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+            }),
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 300000,
             maxRetries: requestOptions?.maxRetries,
         });
@@ -741,12 +782,16 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.9.3",
+                "X-Fern-SDK-Version": "7.9.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
-            body: await serializers.TokenizeRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "passthrough" }),
+            body: await serializers.TokenizeRequest.jsonOrThrow(request, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+            }),
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 300000,
             maxRetries: requestOptions?.maxRetries,
         });
@@ -819,12 +864,16 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.9.3",
+                "X-Fern-SDK-Version": "7.9.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
-            body: await serializers.DetokenizeRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "passthrough" }),
+            body: await serializers.DetokenizeRequest.jsonOrThrow(request, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+            }),
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 300000,
             maxRetries: requestOptions?.maxRetries,
         });
@@ -896,7 +945,7 @@ export class CohereClient {
     }
 
     protected async _getAuthorizationHeader() {
-        const bearer = (await core.Supplier.get(this._options.token)) ?? process.env["CO_API_KEY"];
+        const bearer = (await core.Supplier.get(this._options.token)) ?? process?.env["CO_API_KEY"];
         if (bearer == null) {
             throw new errors.CohereError({
                 message: "Please specify CO_API_KEY when instantiating the client.",

diff --git a/src/api/client/requests/ChatRequest.ts b/src/api/client/requests/ChatRequest.ts
@@ -5,6 +5,36 @@
 import * as Cohere from "../..";
 
 /**
+ * @example
+ *     {
+ *         message: "Can you give me a global market overview of solar panels?",
+ *         stream: false,
+ *         chatHistory: [{
+ *                 role: Cohere.ChatMessageRole.Chatbot,
+ *                 message: "Hi!"
+ *             }, {
+ *                 role: Cohere.ChatMessageRole.Chatbot,
+ *                 message: "How can I help you today?"
+ *             }],
+ *         promptTruncation: Cohere.ChatRequestPromptTruncation.Off,
+ *         temperature: 0.3
+ *     }
+ *
+ * @example
+ *     {
+ *         message: "Can you give me a global market overview of solar panels?",
+ *         stream: false,
+ *         chatHistory: [{
+ *                 role: Cohere.ChatMessageRole.Chatbot,
+ *                 message: "Hi!"
+ *             }, {
+ *                 role: Cohere.ChatMessageRole.Chatbot,
+ *                 message: "How can I help you today?"
+ *             }],
+ *         promptTruncation: Cohere.ChatRequestPromptTruncation.Off,
+ *         temperature: 0.3
+ *     }
+ *
  * @example
  *     {
  *         message: "Can you give me a global market overview of solar panels?",

diff --git a/src/api/client/requests/ChatStreamRequest.ts b/src/api/client/requests/ChatStreamRequest.ts
@@ -4,6 +4,52 @@
 
 import * as Cohere from "../..";
 
+/**
+ * @example
+ *     {
+ *         message: "Can you give me a global market overview of solar panels?",
+ *         stream: true,
+ *         chatHistory: [{
+ *                 role: Cohere.ChatMessageRole.Chatbot,
+ *                 message: "Hi!"
+ *             }, {
+ *                 role: Cohere.ChatMessageRole.Chatbot,
+ *                 message: "How can I help you today?"
+ *             }],
+ *         promptTruncation: Cohere.ChatStreamRequestPromptTruncation.Off,
+ *         temperature: 0.3
+ *     }
+ *
+ * @example
+ *     {
+ *         message: "Can you give me a global market overview of solar panels?",
+ *         stream: true,
+ *         chatHistory: [{
+ *                 role: Cohere.ChatMessageRole.Chatbot,
+ *                 message: "Hi!"
+ *             }, {
+ *                 role: Cohere.ChatMessageRole.Chatbot,
+ *                 message: "How can I help you today?"
+ *             }],
+ *         promptTruncation: Cohere.ChatStreamRequestPromptTruncation.Off,
+ *         temperature: 0.3
+ *     }
+ *
+ * @example
+ *     {
+ *         message: "Can you give me a global market overview of solar panels?",
+ *         stream: true,
+ *         chatHistory: [{
+ *                 role: Cohere.ChatMessageRole.Chatbot,
+ *                 message: "Hi!"
+ *             }, {
+ *                 role: Cohere.ChatMessageRole.Chatbot,
+ *                 message: "How can I help you today?"
+ *             }],
+ *         promptTruncation: Cohere.ChatStreamRequestPromptTruncation.Off,
+ *         temperature: 0.3
+ *     }
+ */
 export interface ChatStreamRequest {
     /**
      * Text input for the model to respond to.