Package dev.langchain4j.store.embedding.weaviate

Class WeaviateEmbeddingStore

java.lang.Object
dev.langchain4j.store.embedding.weaviate.WeaviateEmbeddingStore
All Implemented Interfaces:
EmbeddingStore<TextSegment>
public class WeaviateEmbeddingStore extends Object implements EmbeddingStore<TextSegment>
Represents the Weaviate vector database. Current implementation assumes the cosine distance metric is used.

  • Constructor Details

    • WeaviateEmbeddingStore

      public WeaviateEmbeddingStore(String apiKey, String scheme, String host, Integer port, Boolean useGrpcForInserts, Boolean securedGrpc, Integer grpcPort, String objectClass, Boolean avoidDups, String consistencyLevel, Collection<String> metadataKeys)
      Creates a new WeaviateEmbeddingStore instance.
      Parameters:
      apiKey - Your Weaviate API key. Not required for local deployment.
      scheme - The scheme, e.g. "https" of cluster URL. Find in under Details of your Weaviate cluster.
      host - The host, e.g. "langchain4j-4jw7ufd9.weaviate.network" of cluster URL. Find in under Details of your Weaviate cluster.
      port - The port, e.g. 8080. This parameter is optional.
      useGrpcForInserts - Use GRPC instead of HTTP for batch inserts only. You still need HTTP configured for search
      securedGrpc - The GRPC connection is secured
      grpcPort - The port, e.g. 50051. This parameter is optional.
      objectClass - The object class you want to store, e.g. "MyGreatClass". Must start from an uppercase letter.
      avoidDups - If true (default), then WeaviateEmbeddingStore will generate a hashed ID based on provided text segment, which avoids duplicated entries in DB. If false, then random ID will be generated.
      consistencyLevel - Consistency level: ONE, QUORUM (default) or ALL. Find more details here.
      metadataKeys - Metadata keys that should be persisted (optional)

  • Method Details

    • add

      public String add(Embedding embedding)
      Description copied from interface: EmbeddingStore
      Adds a given embedding to the store.
      Specified by:
      add in interface EmbeddingStore<TextSegment>
      Parameters:
      embedding - The embedding to be added to the store.
      Returns:
      The auto-generated ID associated with the added embedding.

    • add

      public void add(String id, Embedding embedding)
      Adds a new embedding with provided ID to the store.
      Specified by:
      add in interface EmbeddingStore<TextSegment>
      Parameters:
      id - the ID of the embedding to add in UUID format, since it's Weaviate requirement. See Weaviate docs and UUID on Wikipedia
      embedding - the embedding to add

    • add

      public String add(Embedding embedding, TextSegment textSegment)
      Description copied from interface: EmbeddingStore
      Adds a given embedding and the corresponding content that has been embedded to the store.
      Specified by:
      add in interface EmbeddingStore<TextSegment>
      Parameters:
      embedding - The embedding to be added to the store.
      textSegment - Original content that was embedded.
      Returns:
      The auto-generated ID associated with the added embedding.

    • addAll

      public List<String> addAll(List<Embedding> embeddings)
      Description copied from interface: EmbeddingStore
      Adds multiple embeddings to the store.
      Specified by:
      addAll in interface EmbeddingStore<TextSegment>
      Parameters:
      embeddings - A list of embeddings to be added to the store.
      Returns:
      A list of auto-generated IDs associated with the added embeddings.

    • addAll

      public List<String> addAll(List<Embedding> embeddings, List<TextSegment> embedded)
      Description copied from interface: EmbeddingStore
      Adds multiple embeddings and their corresponding contents that have been embedded to the store.
      Specified by:
      addAll in interface EmbeddingStore<TextSegment>
      Parameters:
      embeddings - A list of embeddings to be added to the store.
      embedded - A list of original contents that were embedded.
      Returns:
      A list of auto-generated IDs associated with the added embeddings.

    • removeAll

      public void removeAll(Collection<String> ids)
      Description copied from interface: EmbeddingStore
      Removes all embeddings that match the specified IDs from the store.
      Specified by:
      removeAll in interface EmbeddingStore<TextSegment>
      Parameters:
      ids - A collection of unique IDs of the embeddings to be removed.

    • removeAll

      public void removeAll()
      Description copied from interface: EmbeddingStore
      Removes all embeddings from the store.
      Specified by:
      removeAll in interface EmbeddingStore<TextSegment>

    • findRelevant

      public List<EmbeddingMatch<TextSegment>> findRelevant(Embedding referenceEmbedding, int maxResults, double minCertainty)
      Finds the most relevant (closest in space) embeddings to the provided reference embedding. The score inside EmbeddingMatch is Weaviate's certainty.
      Specified by:
      findRelevant in interface EmbeddingStore<TextSegment>
      Parameters:
      referenceEmbedding - The embedding used as a reference. Returned embeddings should be relevant (closest) to this one.
      maxResults - The maximum number of embeddings to be returned.
      minCertainty - The minimum relevance score, ranging from 0 to 1 (inclusive). Only embeddings with a score of this value or higher will be returned.
      Returns:
      A list of embedding matches. Each embedding match includes a relevance score (derivative of cosine distance), ranging from 0 (not relevant) to 1 (highly relevant).