Function pineconeRetrieverRef

pineconeRetrieverRef function creates a retriever for Pinecone.

  • pineconeRetrieverRef(
        params: { displayName?: string; indexId: string },
    ): RetrieverReference<
        ZodObject<
            extendShape<
                { k: ZodOptional<ZodNumber> },
                {
                    filter: ZodOptional<ZodRecord<ZodString, ZodAny>>;
                    k: ZodNumber;
                    namespace: ZodOptional<ZodString>;
                    sparseVector: ZodOptional<
                        ZodEffects<
                            ZodObject<
                                {
                                    indices: ZodArray<ZodNumber, "many">;
                                    values: ZodArray<ZodNumber, "many">;
                                },
                                "strip",
                                ZodTypeAny,
                                { indices: number[]; values: number[] },
                                { indices: number[]; values: number[] },
                            >,
                            { indices: number[]; values: number[] },
                            { indices: number[]; values: number[] },
                        >,
                    >;
                },
            >,
            "strip",
            ZodTypeAny,
            {
                filter?: Record<string, any>;
                k: number;
                namespace?: string;
                sparseVector?: { indices: number[]; values: number[] };
            },
            {
                filter?: Record<string, any>;
                k: number;
                namespace?: string;
                sparseVector?: { indices: number[]; values: number[] };
            },
        >,
    >

  • Parameters

    • params: { displayName?: string; indexId: string }

      The params for the new Pinecone retriever

      • OptionaldisplayName?: string

        A display name for the retriever. If not specified, the default label will be Pinecone - <indexId>

      • indexId: string

        The indexId for the Pinecone retriever

    Returns RetrieverReference<
        ZodObject<
            extendShape<
                { k: ZodOptional<ZodNumber> },
                {
                    filter: ZodOptional<ZodRecord<ZodString, ZodAny>>;
                    k: ZodNumber;
                    namespace: ZodOptional<ZodString>;
                    sparseVector: ZodOptional<
                        ZodEffects<
                            ZodObject<
                                {
                                    indices: ZodArray<ZodNumber, "many">;
                                    values: ZodArray<ZodNumber, "many">;
                                },
                                "strip",
                                ZodTypeAny,
                                { indices: number[]; values: number[] },
                                { indices: number[]; values: number[] },
                            >,
                            { indices: number[]; values: number[] },
                            { indices: number[]; values: number[] },
                        >,
                    >;
                },
            >,
            "strip",
            ZodTypeAny,
            {
                filter?: Record<string, any>;
                k: number;
                namespace?: string;
                sparseVector?: { indices: number[]; values: number[] };
            },
            {
                filter?: Record<string, any>;
                k: number;
                namespace?: string;
                sparseVector?: { indices: number[]; values: number[] };
            },
        >,
    >

    A reference to a Pinecone retriever.

Settings

Member Visibility