Added example of creating embeddings with the Flux API

Author: rjrudin

examples/client-project/build.gradle

@@ -21,6 +21,7 @@ repositories {
 
 dependencies {
   implementation "com.marklogic:flux-api:1.2.0"
+  implementation "com.marklogic:flux-embedding-model-minilm:1.2.0"
 }
 
 tasks.register("runApp", JavaExec) {
@@ -33,6 +34,15 @@ tasks.register("runApp", JavaExec) {
   ]
 }
 
+tasks.register("runEmbeddingExample", JavaExec) {
+  mainClass = "org.example.ImportWithEmbeddings"
+  classpath = sourceSets.main.runtimeClasspath
+  jvmArgs = [
+    // Required when running on Java 17.
+    '--add-exports=java.base/sun.nio.ch=ALL-UNNAMED'
+  ]
+}
+
 tasks.register("runViaCustomTask") {
   description = "Demonstrate how the Flux API can be used via a custom Gradle task. " +
     "Depends on the example application used in the Getting Started guide. " +

examples/client-project/src/main/java/org/example/ImportWithEmbeddings.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright © 2024 MarkLogic Corporation. All Rights Reserved.
+ */
+package org.example;
+
+import com.marklogic.flux.api.Flux;
+
+public class ImportWithEmbeddings {
+
+    public static void main(String[] args) {
+        // Depends on the example application created in the Getting Started guide.
+        Flux.importGenericFiles()
+            .connectionString("flux-example-user:password@localhost:8004")
+            .from(options -> options
+                .paths("../../flux-cli/src/test/resources/mixed-files/hello.txt"))
+            .to(options -> options
+                .collections("embedder-example")
+                .permissionsString("flux-example-role,read,flux-example-role,update")
+                .splitter(splitterOptions -> splitterOptions.text())
+                .embedder(embedderOptions -> embedderOptions.embedder("minilm"))
+            )
+            .execute();
+    }
+
+}

flux-cli/src/main/java/com/marklogic/flux/api/EmbedderOptions.java

@@ -11,9 +11,18 @@
 public interface EmbedderOptions {
 
     /**
-     * @param name the fully-qualified class name of an implementation of
+     * Valid values:
+     * <ul>
+     *     <li>azure</li>
+     *     <li>minilm</li>
+     *     <li>ollama</li>
+     * </ul>
+     *
+     * @param name either one of the abbreviations listed above, or the fully-qualified class name of an implementation of
      *             {@code java.util.Function<Map<String, String>, dev.langchain4j.model.embedding.EmbeddingModel>} or
-     *             an abbreviation associated with the class name of an implementation.
+     *             an abbreviation associated with the class name of an implementation. Due to a bug in Flux 1.2.0,
+     *             the class name must not contain any uppercase characters. This will be fixed in the next Flux
+     *             release.
      * @return
      */
     EmbedderOptions embedder(String name);