Package com.google.genkit.plugins.pinecone

Class PineconeIndexConfig.Builder

java.lang.Object

com.google.genkit.plugins.pinecone.PineconeIndexConfig.Builder

Enclosing class:

PineconeIndexConfig

public static class PineconeIndexConfig.Builder
extends Object

Builder for PineconeIndexConfig.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PineconeIndexConfig.Builder	additionalMetadata(String key, Object value)	Adds additional metadata to include with all indexed documents.
PineconeIndexConfig.Builder	additionalMetadata(Map<String,Object> metadata)	Sets all additional metadata to include with indexed documents.
PineconeIndexConfig	build()	Builds the PineconeIndexConfig.
PineconeIndexConfig.Builder	cloud(PineconeIndexConfig.Cloud cloud)	Sets the cloud provider for serverless index (default: AWS).
PineconeIndexConfig.Builder	createIndexIfNotExists(boolean createIndexIfNotExists)	Sets whether to create the index if it doesn't exist (default: false).
PineconeIndexConfig.Builder	dimension(int dimension)	Sets the vector dimension (default: 768).
PineconeIndexConfig.Builder	embedderName(String embedderName)	Sets the embedder name for generating vectors (required).
PineconeIndexConfig.Builder	indexName(String indexName)	Sets the index name (required).
PineconeIndexConfig.Builder	metric(PineconeIndexConfig.Metric metric)	Sets the similarity metric (default: COSINE).
PineconeIndexConfig.Builder	namespace(String namespace)	Sets the namespace (default: "" - default namespace).
PineconeIndexConfig.Builder	region(String region)	Sets the region for serverless index (default: "us-east-1").
PineconeIndexConfig.Builder	textField(String textField)	Sets the metadata field name for storing document text (default: "text").

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

indexName

public PineconeIndexConfig.Builder indexName(String indexName)

Sets the index name (required).

embedderName

public PineconeIndexConfig.Builder embedderName(String embedderName)

Sets the embedder name for generating vectors (required).

namespace

public PineconeIndexConfig.Builder namespace(String namespace)

Sets the namespace (default: "" - default namespace).

dimension

public PineconeIndexConfig.Builder dimension(int dimension)

Sets the vector dimension (default: 768).

metric

public PineconeIndexConfig.Builder metric(PineconeIndexConfig.Metric metric)

Sets the similarity metric (default: COSINE).

cloud

public PineconeIndexConfig.Builder cloud(PineconeIndexConfig.Cloud cloud)

Sets the cloud provider for serverless index (default: AWS).

region

public PineconeIndexConfig.Builder region(String region)

Sets the region for serverless index (default: "us-east-1").

createIndexIfNotExists

public PineconeIndexConfig.Builder createIndexIfNotExists(boolean createIndexIfNotExists)

Sets whether to create the index if it doesn't exist (default: false).

textField

public PineconeIndexConfig.Builder textField(String textField)

Sets the metadata field name for storing document text (default: "text").

additionalMetadata

public PineconeIndexConfig.Builder additionalMetadata(String key,
 Object value)

Adds additional metadata to include with all indexed documents.

additionalMetadata

public PineconeIndexConfig.Builder additionalMetadata(Map<String,Object> metadata)

Sets all additional metadata to include with indexed documents.

build

public PineconeIndexConfig build()

Builds the PineconeIndexConfig.

Throws:

IllegalStateException - if required fields are not set