Function configurePineconeIndexer

  • configurePineconeIndexer<
        EmbedderCustomOptions extends
            ZodType<any, any, any, EmbedderCustomOptions>,
    >(
        ai: Genkit,
        params: {
            clientParams?: PineconeConfiguration;
            contentKey?: string;
            embedder: EmbedderArgument<EmbedderCustomOptions>;
            embedderOptions?: TypeOf<EmbedderCustomOptions>;
            indexId: string;
            textKey?: string;
        },
    ): IndexerAction<
        ZodOptional<
            ZodObject<
                { namespace: ZodOptional<ZodString> },
                "strip",
                ZodTypeAny,
                { namespace?: string },
                { namespace?: string },
            >,
        >,
    >

  • Configures a Pinecone indexer.

    Type Parameters

    Parameters

    • ai: Genkit

      A Genkit instance

    • params: {
          clientParams?: PineconeConfiguration;
          contentKey?: string;
          embedder: EmbedderArgument<EmbedderCustomOptions>;
          embedderOptions?: TypeOf<EmbedderCustomOptions>;
          indexId: string;
          textKey?: string;
      }

      The params for the indexer

      • OptionalclientParams?: PineconeConfiguration

        PineconeConfiguration containing the PINECONE_API_KEY. If not set, the PINECONE_API_KEY environment variable will be used instead.

      • OptionalcontentKey?: string

        The metadata key that contains the content. If not specified, the value '_content' is used by default.

      • embedder: EmbedderArgument<EmbedderCustomOptions>

        The embedder to use for the retriever

      • OptionalembedderOptions?: TypeOf<EmbedderCustomOptions>

        Options to customize the embedder

      • indexId: string

        The name of the indexer

      • OptionaltextKey?: string

        Deprecated

        use contentKey instead.

    Returns IndexerAction<
        ZodOptional<
            ZodObject<
                { namespace: ZodOptional<ZodString> },
                "strip",
                ZodTypeAny,
                { namespace?: string },
                { namespace?: string },
            >,
        >,
    >

    A Genkit indexer

Settings

Member Visibility