adding samples

Author: clun

RELEASE.MD

@@ -43,4 +43,11 @@ cd ~/.ssh
 ssh-add githubff4j
 ```
 
+- [x] Deploy
+
+```console
+mvn versions:set -DnewVersion=2.0.0-PREVIEW3 -DgenerateBackupPoms=false
+git tag 2.0.1 && git push origin 2.0.1
+```
+
 

astra-db-java-tools/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.datastax.astra</groupId>
         <artifactId>astra-db-java-parent</artifactId>
-        <version>2.0.0-PREVIEW2</version>
+        <version>2.0.0-PREVIEW3</version>
     </parent>
 
     <dependencies>

astra-db-java/pom.xml

@@ -10,7 +10,7 @@
     <parent>
         <groupId>com.datastax.astra</groupId>
         <artifactId>astra-db-java-parent</artifactId>
-        <version>2.0.0-PREVIEW2</version>
+        <version>2.0.0-PREVIEW3</version>
     </parent>
 
     <properties>
@@ -23,6 +23,7 @@
         <dependency>
             <groupId>com.datastax.astra</groupId>
             <artifactId>astra-sdk-devops</artifactId>
+            <version>${project.version}</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.uuid</groupId>

astra-db-java/src/main/java/com/datastax/astra/client/collections/Collection.java

@@ -59,7 +59,7 @@
 import com.datastax.astra.client.core.query.Filter;
 import com.datastax.astra.client.core.query.Filters;
 import com.datastax.astra.client.core.query.Projection;
-import com.datastax.astra.client.core.rerank.RerankResult;
+import com.datastax.astra.client.core.rerank.RerankedResult;
 import com.datastax.astra.client.core.vector.DataAPIVector;
 import com.datastax.astra.client.databases.Database;
 import com.datastax.astra.client.exceptions.DataAPIException;
@@ -1169,7 +1169,7 @@ public <R> CollectionFindAndRerankCursor<T, R> findAndRerank(Filter filter, Coll
      * @param <R>
      *      the type of the result items after mapping
      * @return
-     *      a {@link Page} of {@link RerankResult} objects containing the paginated reranked results
+     *      a {@link Page} of {@link RerankedResult} objects containing the paginated reranked results
      *
      * <p>Example usage:</p>
      * <pre>
@@ -1181,7 +1181,7 @@ public <R> CollectionFindAndRerankCursor<T, R> findAndRerank(Filter filter, Coll
      * </pre>
      */
     @BetaPreview
-    public <R> Page<RerankResult<R>> findAndRerankPage(Filter filter, CollectionFindAndRerankOptions options, Class<R> newRowType) {
+    public <R> Page<RerankedResult<R>> findAndRerankPage(Filter filter, CollectionFindAndRerankOptions options, Class<R> newRowType) {
         Command findAndRerankCommand = Command
                 .create("findAndRerank")
                 .withFilter(filter);
@@ -1208,7 +1208,7 @@ public <R> Page<RerankResult<R>> findAndRerankPage(Filter filter, CollectionFind
             sortVector = apiResponse.getStatus().getSortVector();
         }
 
-        List<RerankResult<R>> results = new ArrayList<>();
+        List<RerankedResult<R>> results = new ArrayList<>();
         List<Document> documents = apiResponse.getData().getDocuments();
         List<Document> documentResponses = apiResponse.getStatus().getDocumentResponses();
         if (documents == null || documentResponses == null) {
@@ -1233,7 +1233,7 @@ public <R> Page<RerankResult<R>> findAndRerankPage(Filter filter, CollectionFind
             Document documentResponse = documentResponses.get(i);
             Map<String, Double> scores = documentResponse.getMap("scores", String.class, Double.class);
 
-            results.add(new RerankResult<>(results1, scores));
+            results.add(new RerankedResult<>(results1, scores));
         }
         // PageState is always NULL
         return new Page<>(null, results, sortVector);

astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindAndRerankCursor.java

@@ -26,11 +26,13 @@
 import com.datastax.astra.client.core.query.Filter;
 import com.datastax.astra.client.core.query.Projection;
 import com.datastax.astra.client.core.query.Sort;
-import com.datastax.astra.client.core.rerank.RerankResult;
+import com.datastax.astra.client.core.rerank.RerankedResult;
+import com.datastax.astra.client.core.vector.DataAPIVector;
 import com.datastax.astra.internal.command.AbstractCursor;
 import lombok.Getter;
 
 import java.util.ArrayList;
+import java.util.Optional;
 
 
 /**
@@ -50,7 +52,7 @@
  * @param <R>
  *       working object for results, should be same as DOC if no projections
  */
-public class CollectionFindAndRerankCursor<T, R> extends AbstractCursor<T, RerankResult<R>> {
+public class CollectionFindAndRerankCursor<T, R> extends AbstractCursor<T, RerankedResult<R>> {
 
     /**
      * Input table reference
@@ -89,7 +91,7 @@ public class CollectionFindAndRerankCursor<T, R> extends AbstractCursor<T, Reran
      */
     @SuppressWarnings("unchecked")
     public CollectionFindAndRerankCursor(Collection<T> dataSource, Filter filter, CollectionFindAndRerankOptions options, Class<R> recordType) {
-        super((Class<RerankResult<R>>) (Class<?>) RerankResult.class);
+        super((Class<RerankedResult<R>>) (Class<?>) RerankedResult.class);
         this.dataSource = dataSource;
         this.filter = filter;
         this.options = options;

astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindCursor.java

@@ -27,6 +27,7 @@
 import com.datastax.astra.client.core.query.Filter;
 import com.datastax.astra.client.core.query.Projection;
 import com.datastax.astra.client.core.query.Sort;
+import com.datastax.astra.client.core.vector.DataAPIVector;
 import com.datastax.astra.client.tables.definition.rows.Row;
 import com.datastax.astra.internal.command.AbstractCursor;
 import com.datastax.astra.internal.serdes.tables.RowMapper;

astra-db-java/src/main/java/com/datastax/astra/client/core/options/BaseOptions.java

@@ -23,6 +23,7 @@
 import com.datastax.astra.client.core.headers.EmbeddingAPIKeyHeaderProvider;
 import com.datastax.astra.client.core.headers.EmbeddingHeadersProvider;
 import com.datastax.astra.client.core.commands.CommandType;
+import com.datastax.astra.client.core.headers.RerankingAPIKeyHeaderProvider;
 import com.datastax.astra.client.core.headers.RerankingHeadersProvider;
 import com.datastax.astra.client.core.http.HttpClientOptions;
 import com.datastax.astra.internal.command.CommandObserver;
@@ -192,6 +193,19 @@ public T embeddingApiKey(String apiKey) {
         return embeddingAuthProvider(new EmbeddingAPIKeyHeaderProvider(apiKey));
     }
 
+    /**
+     * Provide the reranking service API key.
+     *
+     * @param apiKey
+     *      target api key
+     * @return
+     *      service key
+     */
+    public T rerankingApiKey(String apiKey) {
+        Assert.hasLength(apiKey, "apiKey");
+        return rerankingAuthProvider(new RerankingAPIKeyHeaderProvider(apiKey));
+    }
+
     /**
      * Provide the token.
      *

astra-db-java/src/main/java/com/datastax/astra/client/core/rerank/RerankResult.java renamed to astra-db-java/src/main/java/com/datastax/astra/client/core/rerank/RerankedResult.java

@@ -31,7 +31,7 @@
  *     document result type
  */
 @Getter
-public class RerankResult<DOC> {
+public class RerankedResult<DOC> {
 
     /**
      * Document result.
@@ -51,7 +51,7 @@ public class RerankResult<DOC> {
      * @param scores
      *      score map
      */
-    public RerankResult(DOC document, Map<String, Double> scores) {
+    public RerankedResult(DOC document, Map<String, Double> scores) {
         this.document = document;
         this.scores = scores;
     }

astra-db-java/src/main/java/com/datastax/astra/client/tables/cursor/TableFindCursor.java

@@ -24,12 +24,14 @@
 import com.datastax.astra.client.core.query.Filter;
 import com.datastax.astra.client.core.query.Projection;
 import com.datastax.astra.client.core.query.Sort;
+import com.datastax.astra.client.core.vector.DataAPIVector;
 import com.datastax.astra.client.tables.Table;
 import com.datastax.astra.client.tables.commands.options.TableFindOptions;
 import com.datastax.astra.internal.command.AbstractCursor;
 import lombok.Getter;
 
 import java.util.ArrayList;
+import java.util.Optional;
 
 /**
  * Implementation of a cursor across the find items

astra-db-java/src/test/java/com/datastax/astra/test/integration/astra/DemoAstraDevFindAndRerank.java

@@ -17,7 +17,7 @@
 import com.datastax.astra.client.core.query.Projection;
 import com.datastax.astra.client.core.query.Sort;
 import com.datastax.astra.client.core.rerank.CollectionRerankOptions;
-import com.datastax.astra.client.core.rerank.RerankResult;
+import com.datastax.astra.client.core.rerank.RerankedResult;
 import com.datastax.astra.client.core.rerank.RerankServiceOptions;
 import com.datastax.astra.client.core.vector.SimilarityMetric;
 import com.datastax.astra.client.core.vector.VectorOptions;
@@ -36,7 +36,6 @@
 
 import static com.datastax.astra.client.DataAPIDestination.ASTRA_DEV;
 import static com.datastax.astra.client.core.lexical.AnalyzerTypes.STANDARD;
-import static com.datastax.astra.client.core.lexical.AnalyzerTypes.WHITESPACE;
 import static com.dtsx.astra.sdk.db.domain.CloudProviderType.GCP;
 
 @Slf4j
@@ -287,7 +286,7 @@ public void should_query_collection_bring_my_own_vector() {
                 .hybridLimits(20);
 
         // Run the query
-        List<RerankResult<Document>> result = myCol.findAndRerank(farrOptions).toList();
+        List<RerankedResult<Document>> result = myCol.findAndRerank(farrOptions).toList();
         Assertions.assertNotNull(result);
         Assertions.assertFalse(result.isEmpty());
         System.out.println("Result: " + result.size());