Interface PineconeStoreParams

Database config for your vectorstore.

interface PineconeStoreParams {
    filter?: PineconeMetadata;
    maxConcurrency?: number;
    maxRetries?: number;
    namespace?: string;
    onFailedAttempt?: FailedAttemptHandler;
    pineconeConfig?: {
        additionalHeaders?: HTTPHeaders;
        config: PineconeConfiguration;
        indexHostUrl?: string;
        indexName: string;
        namespace?: string;
    };
    pineconeIndex?: Index<RecordMetadata>;
    textKey?: string;
}

Hierarchy

  • AsyncCallerParams
    • PineconeStoreParams

Properties

filter? maxConcurrency? maxRetries? namespace? onFailedAttempt? pineconeConfig? pineconeIndex? textKey?

Properties

Optionalfilter

filter?: PineconeMetadata

OptionalmaxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

OptionalmaxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

Optionalnamespace

namespace?: string

OptionalonFailedAttempt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

OptionalpineconeConfig

pineconeConfig?: {
    additionalHeaders?: HTTPHeaders;
    config: PineconeConfiguration;
    indexHostUrl?: string;
    indexName: string;
    namespace?: string;
}

Configuration for the Pinecone index. Either this or pineconeIndex must be provided.

OptionalpineconeIndex

pineconeIndex?: Index<RecordMetadata>

The Pinecone index to use. Either this or pineconeConfig must be provided.

OptionaltextKey

textKey?: string

Settings

Member Visibility

On This Page

Properties