Package com.google.genkit.plugins.pinecone

Class PineconeIndexConfig

java.lang.Object

com.google.genkit.plugins.pinecone.PineconeIndexConfig

public class PineconeIndexConfig
extends Object

Configuration for a Pinecone index used for vector storage.

This class configures how documents are stored and retrieved from a Pinecone index.

Example usage:

 PineconeIndexConfig config = PineconeIndexConfig.builder().indexName("my-index")
 		.embedderName("googleai/text-embedding-004").namespace("production").build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PineconeIndexConfig.Builder	Builder for PineconeIndexConfig.
static enum	PineconeIndexConfig.Cloud	Cloud providers for serverless indexes.
static enum	PineconeIndexConfig.Metric	Metric types for vector similarity search.

Method Summary

Modifier and Type	Method	Description
static PineconeIndexConfig.Builder	builder()	Creates a new builder for PineconeIndexConfig.
Map<String,Object>	getAdditionalMetadata()	Gets additional metadata to add to all indexed documents.
PineconeIndexConfig.Cloud	getCloud()	Gets the cloud provider for serverless index.
int	getDimension()	Gets the vector dimension.
String	getEmbedderName()	Gets the embedder name for generating vectors.
String	getIndexName()	Gets the index name.
PineconeIndexConfig.Metric	getMetric()	Gets the similarity metric.
String	getNamespace()	Gets the namespace for this configuration.
String	getRegion()	Gets the region for serverless index.
String	getTextField()	Gets the metadata field name used to store document text.
boolean	isCreateIndexIfNotExists()	Returns whether to create the index if it doesn't exist.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static PineconeIndexConfig.Builder builder()

Creates a new builder for PineconeIndexConfig.

getIndexName

public String getIndexName()

Gets the index name.

getEmbedderName

public String getEmbedderName()

Gets the embedder name for generating vectors.

getNamespace

public String getNamespace()

Gets the namespace for this configuration.

getDimension

public int getDimension()

Gets the vector dimension.

getMetric

public PineconeIndexConfig.Metric getMetric()

Gets the similarity metric.

getCloud

public PineconeIndexConfig.Cloud getCloud()

Gets the cloud provider for serverless index.

getRegion

public String getRegion()

Gets the region for serverless index.

isCreateIndexIfNotExists

public boolean isCreateIndexIfNotExists()

Returns whether to create the index if it doesn't exist.

getTextField

public String getTextField()

Gets the metadata field name used to store document text.

getAdditionalMetadata

public Map<String,Object> getAdditionalMetadata()

Gets additional metadata to add to all indexed documents.