Merge branch 'main' into get_delete_embeddings_space

docs-site/docs/03_components/02_embeddings_space.md

@@ -23,41 +23,17 @@ EmbeddingsStore pineconeStore = new PineconeEmbeddingsStore("YOUR_PINECONE_URL",
 EmbeddingsSpaceComponent embeddingsSpace = new EmbeddingsSpaceComponent(openAIModel, pineconeStore);
 ```
 
-## `generate`
-
-Generates an embedding from a text without persisting it.
-
-- **Parameters**:
-    - `text`: The textual input for embedding.
-    - `additionalMetadata`: Supplementary metadata associated with the text.
-- **Returns**: The generated embedding.
-
-```java
-String sampleText = "Hello, eLLMental!";
-Map<String, String> additionalMetadata = new HashMap<>();
-additionalMetadata.put("key", "value");
-
-Embedding embedding = embeddingsSpace.generate(sampleText, additionalMetadata);
-```
-
 ## `save`
 
 Generates and persists an embedding for a given text.
 
 - **Parameters**:
     - `text`: Text to be embedded.
-    - `additionalMetadata`: (Optional) Additional metadata.
 - **Returns**: The generated embedding.
 
 ```java
-Map<String, String> additionalMetadata = new HashMap<>();
-additionalMetadata.put("key", "value");
-
 String sampleText = "Hello, eLLMental!";
-Embedding embedding = embeddingsSpace.save(sampleText, additionalMetadata);
-
-// Or just
-Embedding embedding = embeddingSpace.save(sampleText);
+Embedding embedding = embeddingsSpace.save(sampleText);
 ```
 
 ## `mostSimilarEmbeddings`

modules/embeddingsgeneration/src/test/java/com/theagilemonkeys/ellmental/embeddingsgeneration/openai/OpenAIEmbeddingsModelTest.java

@@ -9,7 +9,7 @@
 import java.util.List;
 
 public class OpenAIEmbeddingsModelTest {
-    @Test
+   @Test
     public void testGenerateEmbedding(){
         OpenAIEmbeddingsModel openAI = new OpenAIEmbeddingsModel("fakeAPIKey");
         Embedding embedding =  openAI.generateEmbedding("The Agile Monkeys rule!");

modules/embeddingsspace/src/main/java/com/theagilemonkeys/ellmental/embeddingsspace/EmbeddingsSpaceComponent.java

@@ -41,5 +41,4 @@ public Embedding get(UUID uuid) {
     public void delete(UUID uuid) {
         embeddingsStore.delete(uuid);
     }
-
 }

modules/embeddingsspace/src/test/java/com/theagilemonkeys/ellmental/embeddingsspace/EmbeddingsSpaceComponentTest.java

@@ -97,4 +97,4 @@ public void testDeleteEmbedding() {
 
         verifyNoMoreInteractions(embeddingsGenerationModel, embeddingsStore);
     }
-}
+}

settings.gradle

@@ -4,6 +4,6 @@ include(
         "core",
         "modules:embeddingsgeneration",
         "modules:embeddingsstore",
+        "modules:embeddingsspace",
         "examples:simplejava"
 )
-