Function pineconeRetrieverRef

pineconeRetrieverRef function creates a retriever for Pinecone.

  • pineconeRetrieverRef(
        params: { displayName?: string; indexId: string },
    ): RetrieverReference<
        z.ZodObject<
            z.objectUtil.extendShape<
                { k: z.ZodOptional<z.ZodNumber> },
                {
                    filter: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
                    k: z.ZodNumber;
                    namespace: z.ZodOptional<z.ZodString>;
                    sparseVector: z.ZodOptional<
                        z.ZodEffects<
                            z.ZodObject<
                                {
                                    indices: z.ZodArray<z.ZodNumber, "many">;
                                    values: z.ZodArray<z.ZodNumber, "many">;
                                },
                                "strip",
                                z.ZodTypeAny,
                                { indices: number[]; values: number[] },
                                { indices: number[]; values: number[] },
                            >,
                            { indices: number[]; values: number[] },
                            { indices: number[]; values: number[] },
                        >,
                    >;
                },
            >,
            "strip",
            z.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<
        z.ZodObject<
            z.objectUtil.extendShape<
                { k: z.ZodOptional<z.ZodNumber> },
                {
                    filter: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
                    k: z.ZodNumber;
                    namespace: z.ZodOptional<z.ZodString>;
                    sparseVector: z.ZodOptional<
                        z.ZodEffects<
                            z.ZodObject<
                                {
                                    indices: z.ZodArray<z.ZodNumber, "many">;
                                    values: z.ZodArray<z.ZodNumber, "many">;
                                },
                                "strip",
                                z.ZodTypeAny,
                                { indices: number[]; values: number[] },
                                { indices: number[]; values: number[] },
                            >,
                            { indices: number[]; values: number[] },
                            { indices: number[]; values: number[] },
                        >,
                    >;
                },
            >,
            "strip",
            z.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