Add spec changes

Co-authored-by: Michael <michael@cohere.com>
cohere-ai · Nov 22, 2024 · 8c2e71a · 8c2e71a
1 parent 6054952
commit 8c2e71a
Show file tree

Hide file tree

Showing 11 changed files with 85 additions and 188 deletions.
diff --git a/cohere-openapi.yaml b/cohere-openapi.yaml
diff --git a/snippets/snippets/curl/rerank-v2-post.sh b/snippets/snippets/curl/rerank-v2-post.sh
@@ -11,5 +11,5 @@ curl --request POST \
                   "The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean. Its capital is Saipan.",
                   "Washington, D.C. (also known as simply Washington or D.C., and officially as the District of Columbia) is the capital of the United States. It is a federal district.",
                   "Capitalization or capitalisation in English grammar is the use of a capital letter at the start of a word. English usage varies from capitalization in other languages.",
-                  "Capital punishment (the death penalty) has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states."]
+                  "Capital punishment has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states."]
   }'
diff --git a/snippets/snippets/java/app/src/main/java/RerankV2Post.java b/snippets/snippets/java/app/src/main/java/RerankV2Post.java
@@ -1,7 +1,6 @@
 /* (C)2024 */
 import com.cohere.api.Cohere;
 import com.cohere.api.resources.v2.requests.V2RerankRequest;
-import com.cohere.api.resources.v2.types.V2RerankRequestDocumentsItem;
 import com.cohere.api.resources.v2.types.V2RerankResponse;
 import java.util.List;
 
@@ -18,40 +17,18 @@ public static void main(String[] args) {
                     .query("What is the capital of the United States?")
                     .documents(
                         List.of(
-                            V2RerankRequestDocumentsItem.of(
-                                "Carson City is the capital city of"
-                                    + " the American state of"
-                                    + " Nevada."),
-                            V2RerankRequestDocumentsItem.of(
-                                "The Commonwealth of the Northern"
-                                    + " Mariana Islands is a group"
-                                    + " of islands in the Pacific"
-                                    + " Ocean. Its capital is"
-                                    + " Saipan."),
-                            V2RerankRequestDocumentsItem.of(
-                                "Capitalization or capitalisation"
-                                    + " in English grammar is the"
-                                    + " use of a capital letter at"
-                                    + " the start of a word."
-                                    + " English usage varies from"
-                                    + " capitalization in other"
-                                    + " languages."),
-                            V2RerankRequestDocumentsItem.of(
-                                "Washington, D.C. (also known as"
-                                    + " simply Washington or D.C.,"
-                                    + " and officially as the"
-                                    + " District of Columbia) is"
-                                    + " the capital of the United"
-                                    + " States. It is a federal"
-                                    + " district."),
-                            V2RerankRequestDocumentsItem.of(
-                                "Capital punishment (the death"
-                                    + " penalty) has existed in the"
-                                    + " United States since"
-                                    + " beforethe United States was"
-                                    + " a country. As of 2017,"
-                                    + " capital punishment is legal"
-                                    + " in 30 of the 50 states.")))
+                            "Carson City is the capital city of the American state of Nevada.",
+                            "The Commonwealth of the Northern Mariana Islands is a group of islands"
+                                + " in the Pacific Ocean. Its capital is Saipan.",
+                            "Capitalization or capitalisation in English grammar is the use of a"
+                                + " capital letter at the start of a word. English usage varies"
+                                + " from capitalization in other languages.",
+                            "Washington, D.C. (also known as simply Washington or D.C., and"
+                                + " officially as the District of Columbia) is the capital of the"
+                                + " United States. It is a federal district.",
+                            "Capital punishment has existed in the United States since before the"
+                                + " United States was a country. As of 2017, capital punishment is"
+                                + " legal in 30 of the 50 states."))
                     .topN(3)
                     .build());
 

diff --git a/snippets/snippets/java/app/src/main/java/embedpost/EmbedImagePost.java b/snippets/snippets/java/app/src/main/java/embedpost/EmbedImagePost.java
@@ -16,9 +16,7 @@ public class EmbedImagePost {
   public static void main(String[] args) {
     Cohere cohere = Cohere.builder().clientName("snippet").build();
 
-    URL url =
-        URI.toUrl(
-            "https://cohere.com/favicon-32x32.png");
+    URL url = URI.toUrl("https://cohere.com/favicon-32x32.png");
     HttpURLConnection connection = (HttpURLConnection) url.openConnection();
     connection.connect();
 

diff --git a/snippets/snippets/java/app/src/main/java/embedv2post/EmbedImagePost.java b/snippets/snippets/java/app/src/main/java/embedv2post/EmbedImagePost.java
@@ -1,25 +1,22 @@
 package embedv2post; /* (C)2024 */
 
+import com.cohere.api.Cohere;
+import com.cohere.api.resources.v2.requests.V2EmbedRequest;
+import com.cohere.api.types.EmbedByTypeResponse;
+import com.cohere.api.types.EmbedInputType;
+import com.cohere.api.types.EmbeddingType;
 import java.io.InputStream;
 import java.net.HttpURLConnection;
 import java.net.URI;
 import java.net.URL;
 import java.util.Base64;
 import java.util.List;
 
-import com.cohere.api.Cohere;
-import com.cohere.api.resources.v2.requests.V2EmbedRequest;
-import com.cohere.api.types.EmbedByTypeResponse;
-import com.cohere.api.types.EmbedInputType;
-import com.cohere.api.types.EmbeddingType;
-
 public class EmbedImagePost {
   public static void main(String[] args) {
     Cohere cohere = Cohere.builder().clientName("snippet").build();
 
-    URL url =
-        URI.toUrl(
-            "https://cohere.com/favicon-32x32.png");
+    URL url = URI.toUrl("https://cohere.com/favicon-32x32.png");
     HttpURLConnection connection = (HttpURLConnection) url.openConnection();
     connection.connect();
 

diff --git a/snippets/snippets/java/app/src/main/java/embedv2post/EmbedPost.java b/snippets/snippets/java/app/src/main/java/embedv2post/EmbedPost.java
@@ -1,11 +1,10 @@
 package embedv2post; /* (C)2024 */
 
-import java.util.List;
-
 import com.cohere.api.Cohere;
 import com.cohere.api.resources.v2.requests.V2EmbedRequest;
 import com.cohere.api.types.EmbedByTypeResponse;
 import com.cohere.api.types.EmbedInputType;
+import java.util.List;
 
 public class EmbedPost {
   public static void main(String[] args) {

diff --git a/snippets/snippets/node/rerank-v2-post.ts b/snippets/snippets/node/rerank-v2-post.ts
@@ -5,19 +5,11 @@ const cohere = new CohereClient({});
 (async () => {
   const rerank = await cohere.v2.rerank({
     documents: [
-      { text: 'Carson City is the capital city of the American state of Nevada.' },
-      {
-        text: 'The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean. Its capital is Saipan.',
-      },
-      {
-        text: 'Capitalization or capitalisation in English grammar is the use of a capital letter at the start of a word. English usage varies from capitalization in other languages.',
-      },
-      {
-        text: 'Washington, D.C. (also known as simply Washington or D.C., and officially as the District of Columbia) is the capital of the United States. It is a federal district.',
-      },
-      {
-        text: 'Capital punishment (the death penalty) has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states.',
-      },
+      'Carson City is the capital city of the American state of Nevada.',
+      'The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean. Its capital is Saipan.',
+      'Capitalization or capitalisation in English grammar is the use of a capital letter at the start of a word. English usage varies from capitalization in other languages.',
+      'Washington, D.C. (also known as simply Washington or D.C., and officially as the District of Columbia) is the capital of the United States. It is a federal district.',
+      'Capital punishment has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states.',
     ],
     query: 'What is the capital of the United States?',
     topN: 3,

diff --git a/snippets/snippets/python-async/rerank-v2-post.py b/snippets/snippets/python-async/rerank-v2-post.py
@@ -8,7 +8,7 @@
     "The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean. Its capital is Saipan.",
     "Capitalization or capitalisation in English grammar is the use of a capital letter at the start of a word. English usage varies from capitalization in other languages.",
     "Washington, D.C. (also known as simply Washington or D.C., and officially as the District of Columbia) is the capital of the United States. It is a federal district.",
-    "Capital punishment (the death penalty) has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states.",
+    "Capital punishment has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states.",
 ]
 
 

diff --git a/snippets/snippets/python/rerank-v2-post.py b/snippets/snippets/python/rerank-v2-post.py
@@ -7,7 +7,7 @@
     "The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean. Its capital is Saipan.",
     "Capitalization or capitalisation in English grammar is the use of a capital letter at the start of a word. English usage varies from capitalization in other languages.",
     "Washington, D.C. (also known as simply Washington or D.C., and officially as the District of Columbia) is the capital of the United States. It is a federal district.",
-    "Capital punishment (the death penalty) has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states.",
+    "Capital punishment has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states.",
 ]
 
 response = co.rerank(

diff --git a/snippets/snippets/requests/rerank-v2-post.yaml b/snippets/snippets/requests/rerank-v2-post.yaml
@@ -1,14 +1,14 @@
 documents:
-  - text: Carson City is the capital city of the American state of Nevada.
-  - text: The Commonwealth of the Northern Mariana Islands is a group of islands in
+  - Carson City is the capital city of the American state of Nevada.
+  - The Commonwealth of the Northern Mariana Islands is a group of islands in
       the Pacific Ocean. Its capital is Saipan.
-  - text: Capitalization or capitalisation in English grammar is the use of a
+  - Capitalization or capitalisation in English grammar is the use of a
       capital letter at the start of a word. English usage varies from
       capitalization in other languages.
-  - text: Washington, D.C. (also known as simply Washington or D.C., and officially
+  - Washington, D.C. (also known as simply Washington or D.C., and officially
       as the District of Columbia) is the capital of the United States. It is a
       federal district.
-  - text: Capital punishment (the death penalty) has existed in the United States
+  - Capital punishment (the death penalty) has existed in the United States
       since beforethe United States was a country. As of 2017, capital
       punishment is legal in 30 of the 50 states.
 query: What is the capital of the United States?

diff --git a/snippets/snippets/responses/rerank-v2-post.yaml b/snippets/snippets/responses/rerank-v2-post.yaml
@@ -10,8 +10,6 @@ body:
   meta:
     api_version:
       version: '2'
-      is_experimental: true
-    warnings:
-    - You are using an experimental version, for more information please refer to https://docs.cohere.com/versioning-reference
+      is_experimental: false
     billed_units:
       search_units: 1