Package dev.langchain4j.store.embedding.pinecone

Class PineconeEmbeddingStore.Builder

java.lang.Object

dev.langchain4j.store.embedding.pinecone.PineconeEmbeddingStore.Builder

Enclosing class:

PineconeEmbeddingStore

public static class PineconeEmbeddingStore.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PineconeEmbeddingStore.Builder	apiKey(String apiKey)
PineconeEmbeddingStore	build()
PineconeEmbeddingStore.Builder	createIndex(PineconeIndexConfig createIndex)
PineconeEmbeddingStore.Builder	environment(String environment)	Deprecated, for removal: This API element is subject to removal in a future version. Please use createIndex(PineconeIndexConfig)
PineconeEmbeddingStore.Builder	index(String index)
PineconeEmbeddingStore.Builder	metadataTextKey(String metadataTextKey)
PineconeEmbeddingStore.Builder	nameSpace(String nameSpace)
PineconeEmbeddingStore.Builder	projectId(String projectId)	Deprecated, for removal: This API element is subject to removal in a future version. Please use createIndex(PineconeIndexConfig)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

apiKey

public PineconeEmbeddingStore.Builder apiKey(String apiKey)

Parameters:

apiKey - The Pinecone API key.

index

public PineconeEmbeddingStore.Builder index(String index)

Parameters:

index - The name of the index (e.g., "test").

nameSpace

public PineconeEmbeddingStore.Builder nameSpace(String nameSpace)

Parameters:

nameSpace - (Optional) Namespace. If not provided, "default" will be used.

metadataTextKey

public PineconeEmbeddingStore.Builder metadataTextKey(String metadataTextKey)

Parameters:

metadataTextKey - (Optional) The key to find the text in the metadata. If not provided, "text_segment" will be used.

createIndex

public PineconeEmbeddingStore.Builder createIndex(PineconeIndexConfig createIndex)

Parameters:

createIndex - (Optional) The key to find the text in the metadata. If not provided, "text_segment" will be used.

environment

@Deprecated(forRemoval=true)
public PineconeEmbeddingStore.Builder environment(String environment)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use createIndex(PineconeIndexConfig)

Parameters:

environment - The environment (e.g., "northamerica-northeast1-gcp").

projectId

@Deprecated(forRemoval=true)
public PineconeEmbeddingStore.Builder projectId(String projectId)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use createIndex(PineconeIndexConfig)

Parameters:

projectId - The ID of the project (e.g., "19a129b"). This is not a project name. The ID can be found in the Pinecone URL: https://app.pinecone.io/organizations/.../projects/...:{projectId}/indexes.

build

public PineconeEmbeddingStore build()