Merge pull request #206 from rosette-api/RD-2603

RD-2603: Add Rosette options to control the semantics endpoints’ embeddings

Author: Katsuya-Tomioka

examples/src/main/java/com/basistech/rosette/examples/SemanticVectorsExample.java

@@ -1,22 +1,23 @@
 /*
-* Copyright 2022 Basis Technology Corp.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Copyright 2023 Basis Technology Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package com.basistech.rosette.examples;
 
 import com.basistech.rosette.api.HttpRosetteAPI;
 import com.basistech.rosette.apimodel.DocumentRequest;
+import com.basistech.rosette.apimodel.EmbeddingsMode;
 import com.basistech.rosette.apimodel.SemanticVectorsOptions;
 import com.basistech.rosette.apimodel.SemanticVectorsResponse;
 
@@ -50,6 +51,9 @@ private void run() throws IOException {
         // When no options, use <?>.
         DocumentRequest<SemanticVectorsOptions> request = DocumentRequest.<SemanticVectorsOptions>builder()
             .content(semanticVectorsData)
+            .options(SemanticVectorsOptions.builder()
+                .embeddingsMode(EmbeddingsMode.GEN_1)
+                .build())
             .build();
         SemanticVectorsResponse response = rosetteApi.perform(SEMANTIC_VECTORS_SERVICE_PATH, request, SemanticVectorsResponse.class);
         System.out.println(responseToJson(response));

examples/src/main/java/com/basistech/rosette/examples/SimilarTermsExample.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Basis Technology Corp.
+ * Copyright 2023 Basis Technology Corp.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,7 @@
 
 import com.basistech.rosette.api.HttpRosetteAPI;
 import com.basistech.rosette.apimodel.DocumentRequest;
+import com.basistech.rosette.apimodel.EmbeddingsMode;
 import com.basistech.rosette.apimodel.SimilarTermsOptions;
 import com.basistech.rosette.apimodel.SimilarTermsResponse;
 import com.basistech.util.LanguageCode;
@@ -54,6 +55,7 @@ private void run() throws IOException {
         DocumentRequest<SimilarTermsOptions> request = DocumentRequest.<SimilarTermsOptions>builder()
                 .content(similarTermsData)
                 .options(SimilarTermsOptions.builder()
+                        .embeddingsMode(EmbeddingsMode.GEN_1)
                         .resultLanguages(Lists.newArrayList(LanguageCode.SPANISH, LanguageCode.GERMAN, LanguageCode.JAPANESE))
                         .build())
                 .build();

model/src/main/java/com/basistech/rosette/apimodel/EmbeddingsMode.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2023 Basis Technology Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basistech.rosette.apimodel;
+
+/**
+ * The generation of embeddings to use for all languages. Defaults to second generation unless the language only
+ * supports first generation embeddings
+ */
+public enum EmbeddingsMode {
+    DEFAULT,
+    GEN_1,
+    GEN_2,
+    /**/;
+}

model/src/main/java/com/basistech/rosette/apimodel/SemanticVectorsOptions.java

@@ -1,18 +1,18 @@
 /*
-* Copyright 2018 Basis Technology Corp.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Copyright 2023 Basis Technology Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package com.basistech.rosette.apimodel;
 
 import com.basistech.rosette.annotations.JacksonMixin;
@@ -32,4 +32,9 @@ public class SemanticVectorsOptions extends Options {
      */
     private Boolean perToken;
 
+    /**
+     * @return the generation of embeddings to use for all languages, defaulting to second generation embeddings unless
+     * the language supports first generation embeddings
+     */
+    private EmbeddingsMode embeddingsMode;
 }

model/src/main/java/com/basistech/rosette/apimodel/SimilarTermsOptions.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018 Basis Technology Corp.
+ * Copyright 2023 Basis Technology Corp.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -42,4 +42,10 @@ public class SimilarTermsOptions extends Options {
      * @return the number of similar terms requested
      */
     private final Integer count;
+
+    /**
+     * @return the generation of embeddings to use for all languages, defaulting to second generation embeddings unless
+     * the language supports first generation embeddings
+     */
+    private EmbeddingsMode embeddingsMode;
 }