Class PineconeEmbeddingStore
java.lang.Object
dev.langchain4j.store.embedding.pinecone.PineconeEmbeddingStore
- All Implemented Interfaces:
EmbeddingStore<TextSegment>
Represents a Pinecone index as an embedding store.
Current implementation assumes the index uses the cosine distance metric.
-
Nested Class Summary
Nested Classes -
Constructor Summary
ConstructorsConstructorDescriptionPineconeEmbeddingStore
(String apiKey, String index, String nameSpace, String metadataTextKey, PineconeIndexConfig createIndex, String environment, String projectId) Creates an instance of PineconeEmbeddingStore. -
Method Summary
Modifier and TypeMethodDescriptionAdds a given embedding to the store.add
(Embedding embedding, TextSegment textSegment) Adds a given embedding and the corresponding content that has been embedded to the store.void
Adds a given embedding to the store.Adds multiple embeddings to the store.addAll
(List<Embedding> embeddings, List<TextSegment> textSegments) Adds multiple embeddings and their corresponding contents that have been embedded to the store.builder()
void
Removes all embeddings from the store.void
removeAll
(Collection<String> ids) Removes all embeddings that match the specified IDs from the store.search
(EmbeddingSearchRequest request) Searches for the most similar (closest in the embedding space)Embedding
s.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface dev.langchain4j.store.embedding.EmbeddingStore
findRelevant, findRelevant, findRelevant, findRelevant, remove, removeAll
-
Constructor Details
-
PineconeEmbeddingStore
public PineconeEmbeddingStore(String apiKey, String index, String nameSpace, String metadataTextKey, PineconeIndexConfig createIndex, String environment, String projectId) Creates an instance of PineconeEmbeddingStore.- Parameters:
apiKey
- The Pinecone API key.index
- The name of the index (e.g., "test").nameSpace
- (Optional) Namespace. If not provided, "default" will be used.metadataTextKey
- (Optional) The key to find the text in the metadata. If not provided, "text_segment" will be used.createIndex
- (Optional) Configuration parameters to create an index, seePineconeServerlessIndexConfig
andPineconePodIndexConfig
environment
- (Deprecated) Please use @PineconeEmbeddingStore.Builder.createIndex(PineconeIndexConfig)
.projectId
- (Deprecated) Please use @PineconeEmbeddingStore.Builder.createIndex(PineconeIndexConfig)
.
-
-
Method Details
-
builder
-
add
Description copied from interface:EmbeddingStore
Adds a given embedding to the store.- Specified by:
add
in interfaceEmbeddingStore<TextSegment>
- Parameters:
embedding
- The embedding to be added to the store.- Returns:
- The auto-generated ID associated with the added embedding.
-
add
Description copied from interface:EmbeddingStore
Adds a given embedding to the store.- Specified by:
add
in interfaceEmbeddingStore<TextSegment>
- Parameters:
id
- The unique identifier for the embedding to be added.embedding
- The embedding to be added to the store.
-
add
Description copied from interface:EmbeddingStore
Adds a given embedding and the corresponding content that has been embedded to the store.- Specified by:
add
in interfaceEmbeddingStore<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
Description copied from interface:EmbeddingStore
Adds multiple embeddings to the store.- Specified by:
addAll
in interfaceEmbeddingStore<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
Description copied from interface:EmbeddingStore
Adds multiple embeddings and their corresponding contents that have been embedded to the store.- Specified by:
addAll
in interfaceEmbeddingStore<TextSegment>
- Parameters:
embeddings
- A list of embeddings to be added to the store.textSegments
- A list of original contents that were embedded.- Returns:
- A list of auto-generated IDs associated with the added embeddings.
-
removeAll
Description copied from interface:EmbeddingStore
Removes all embeddings that match the specified IDs from the store.- Specified by:
removeAll
in interfaceEmbeddingStore<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 interfaceEmbeddingStore<TextSegment>
-
search
Description copied from interface:EmbeddingStore
Searches for the most similar (closest in the embedding space)Embedding
s.
All search criteria are defined inside theEmbeddingSearchRequest
.
EmbeddingSearchRequest.filter()
can be used to filter by user/memory ID. Please note that not allEmbeddingStore
implementations supportFilter
ing.- Specified by:
search
in interfaceEmbeddingStore<TextSegment>
- Parameters:
request
- A request to search in anEmbeddingStore
. Contains all search criteria.- Returns:
- An
EmbeddingSearchResult
containing all foundEmbedding
s.
-