🌿 Fern Regeneration -- September 19, 2024 (#203)

* SDK regeneration * Fix types --------- Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Billy Trend <[email protected]>
cohere-ai · Sep 19, 2024 · 499bde5 · 499bde5
1 parent 80d9420
commit 499bde5
Show file tree

Hide file tree

Showing 186 changed files with 2,493 additions and 1,334 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "cohere-ai",
-    "version": "7.13.1",
+    "version": "7.13.2",
     "private": false,
     "repository": "https://github.com/cohere-ai/cohere-typescript",
     "main": "./index.js",

diff --git a/reference.md b/reference.md
@@ -59,7 +59,7 @@ await client.checkApiKey();
 
 ## V2
 
-<details><summary><code>client.v2.<a href="/src/api/resources/v2/client/Client.ts">chatStream</a>({ ...params }) -> core.Stream<Cohere.StreamedChatResponse2></code></summary>
+<details><summary><code>client.v2.<a href="/src/api/resources/v2/client/Client.ts">chatStream</a>({ ...params }) -> core.Stream<Cohere.StreamedChatResponseV2></code></summary>
 <dl>
 <dd>
 
@@ -93,13 +93,6 @@ await client.v2.chatStream({
         {
             role: "user",
             content: "string",
-            documents: [
-                {
-                    string: {
-                        key: "value",
-                    },
-                },
-            ],
         },
     ],
     tools: [
@@ -116,7 +109,10 @@ await client.v2.chatStream({
             },
         },
     ],
-    citationMode: Cohere.V2ChatStreamRequestCitationMode.Fast,
+    documents: ["string"],
+    citationOptions: {
+        mode: Cohere.CitationOptionsMode.Fast,
+    },
     responseFormat: {
         type: "text",
     },
@@ -165,7 +161,7 @@ await client.v2.chatStream({
 </dl>
 </details>
 
-<details><summary><code>client.v2.<a href="/src/api/resources/v2/client/Client.ts">chat</a>({ ...params }) -> Cohere.NonStreamedChatResponse2</code></summary>
+<details><summary><code>client.v2.<a href="/src/api/resources/v2/client/Client.ts">chat</a>({ ...params }) -> Cohere.ChatResponse</code></summary>
 <dl>
 <dd>
 
@@ -199,7 +195,7 @@ await client.v2.chat({
         {
             role: "tool",
             toolCallId: "messages",
-            toolContent: ["messages"],
+            toolContent: "messages",
         },
     ],
 });
@@ -237,6 +233,144 @@ await client.v2.chat({
 </dl>
 </details>
 
+<details><summary><code>client.v2.<a href="/src/api/resources/v2/client/Client.ts">embed</a>({ ...params }) -> Cohere.EmbedByTypeResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+This endpoint returns text embeddings. An embedding is a list of floating point numbers that captures semantic information about the text that it represents.
+
+Embeddings can be used to create text classifiers as well as empower semantic search. To learn more about embeddings, see the embedding page.
+
+If you want to learn more how to use the embedding model, have a look at the [Semantic Search Guide](/docs/semantic-search).
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.v2.embed({
+    inputType: "image",
+    images: ["string"],
+    model: "string",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Cohere.EmbedRequestV2`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V2.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.v2.<a href="/src/api/resources/v2/client/Client.ts">rerank</a>({ ...params }) -> Cohere.V2RerankResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+This endpoint takes in a query and a list of texts and produces an ordered array with each text assigned a relevance score.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.v2.rerank({
+    model: "model",
+    query: "query",
+    documents: ["documents"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Cohere.V2RerankRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V2.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## EmbedJobs
 
 <details><summary><code>client.embedJobs.<a href="/src/api/resources/embedJobs/client/Client.ts">list</a>() -> Cohere.ListEmbedJobResponse</code></summary>

diff --git a/src/Client.ts b/src/Client.ts
@@ -42,7 +42,7 @@ export class CohereClient {
 
     /**
      * Generates a text response to a user message.
-     * To learn how to use the Chat API with Streaming and RAG follow our [Text Generation guides](https://docs.cohere.com/docs/chat-api).
+     * To learn how to use the Chat API and RAG follow our [Text Generation guides](https://docs.cohere.com/docs/chat-api).
      */
     public async chatStream(
         request: Cohere.ChatStreamRequest,
@@ -63,8 +63,8 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.13.1",
-                "User-Agent": "cohere-ai/7.13.1",
+                "X-Fern-SDK-Version": "7.13.2",
+                "User-Agent": "cohere-ai/7.13.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 Accepts: accepts != null ? accepts : undefined,
@@ -193,7 +193,7 @@ export class CohereClient {
 
     /**
      * Generates a text response to a user message.
-     * To learn how to use the Chat API with Streaming and RAG follow our [Text Generation guides](https://docs.cohere.com/docs/chat-api).
+     * To learn how to use the Chat API and RAG follow our [Text Generation guides](https://docs.cohere.com/docs/chat-api).
      *
      * @param {Cohere.ChatRequest} request
      * @param {CohereClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -241,8 +241,8 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.13.1",
-                "User-Agent": "cohere-ai/7.13.1",
+                "X-Fern-SDK-Version": "7.13.2",
+                "User-Agent": "cohere-ai/7.13.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 Accepts: accepts != null ? accepts : undefined,
@@ -382,8 +382,8 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.13.1",
-                "User-Agent": "cohere-ai/7.13.1",
+                "X-Fern-SDK-Version": "7.13.2",
+                "User-Agent": "cohere-ai/7.13.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -553,8 +553,8 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.13.1",
-                "User-Agent": "cohere-ai/7.13.1",
+                "X-Fern-SDK-Version": "7.13.2",
+                "User-Agent": "cohere-ai/7.13.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -712,8 +712,8 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.13.1",
-                "User-Agent": "cohere-ai/7.13.1",
+                "X-Fern-SDK-Version": "7.13.2",
+                "User-Agent": "cohere-ai/7.13.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -867,8 +867,8 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.13.1",
-                "User-Agent": "cohere-ai/7.13.1",
+                "X-Fern-SDK-Version": "7.13.2",
+                "User-Agent": "cohere-ai/7.13.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -1022,8 +1022,8 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.13.1",
-                "User-Agent": "cohere-ai/7.13.1",
+                "X-Fern-SDK-Version": "7.13.2",
+                "User-Agent": "cohere-ai/7.13.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -1179,8 +1179,8 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.13.1",
-                "User-Agent": "cohere-ai/7.13.1",
+                "X-Fern-SDK-Version": "7.13.2",
+                "User-Agent": "cohere-ai/7.13.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -1334,8 +1334,8 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.13.1",
-                "User-Agent": "cohere-ai/7.13.1",
+                "X-Fern-SDK-Version": "7.13.2",
+                "User-Agent": "cohere-ai/7.13.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -1489,8 +1489,8 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.13.1",
-                "User-Agent": "cohere-ai/7.13.1",
+                "X-Fern-SDK-Version": "7.13.2",
+                "User-Agent": "cohere-ai/7.13.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -1637,8 +1637,8 @@ export class CohereClient {
                         : undefined,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "cohere-ai",
-                "X-Fern-SDK-Version": "7.13.1",
-                "User-Agent": "cohere-ai/7.13.1",
+                "X-Fern-SDK-Version": "7.13.2",
+                "User-Agent": "cohere-ai/7.13.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },

diff --git a/src/ClientV2.ts b/src/ClientV2.ts
@@ -2,7 +2,7 @@ import { V2 } from "./api/resources/v2/client/Client";
 import { CohereClient } from "./Client";
 
 // this class will require manual updates over time
-export class CohereClientV2 implements Omit<CohereClient, "chat" | "chatStream" | "v2">, Pick<V2, keyof V2> {
+export class CohereClientV2 implements Omit<CohereClient, keyof V2 | "v2">, Pick<V2, keyof V2> {
     constructor(private _options: CohereClient.Options) {
     }
 
@@ -11,11 +11,11 @@ export class CohereClientV2 implements Omit<CohereClient, "chat" | "chatStream"
 
     chat = this.clientV2.chat.bind(this.clientV2)
     chatStream = this.clientV2.chatStream.bind(this.clientV2)
+    embed = this.clientV2.embed.bind(this.clientV2)
+    rerank = this.clientV2.rerank.bind(this.clientV2)
 
     generateStream = this.client.generateStream.bind(this.clientV2)
     generate = this.client.generate.bind(this.clientV2)
-    embed = this.client.embed.bind(this.clientV2)
-    rerank = this.client.rerank.bind(this.clientV2)
     classify = this.client.classify.bind(this.clientV2)
     summarize = this.client.summarize.bind(this.clientV2)
     tokenize = this.client.tokenize.bind(this.clientV2)