Function chromaRetrieverRef

  • chromaRetrieverRef(
        params: { collectionName: string; displayName?: string },
    ): RetrieverReference<
        ZodOptional<
            ZodObject<
                extendShape<
                    { k: ZodOptional<ZodNumber> },
                    {
                        include: ZodOptional<
                            ZodArray<
                                ZodEnum<["documents", "embeddings", "metadatas", "distances"]>,
                                "many",
                            >,
                        >;
                        where: ZodOptional<ZodType<Where, ZodTypeDef, Where>>;
                        whereDocument: ZodOptional<
                            ZodType<WhereDocument, ZodTypeDef, WhereDocument>,
                        >;
                    },
                >,
                "strip",
                ZodTypeAny,
                {
                    include?: ("documents" | "embeddings" | "metadatas" | "distances")[];
                    k?: number;
                    where?: Where;
                    whereDocument?: WhereDocument;
                },
                {
                    include?: ("documents" | "embeddings" | "metadatas" | "distances")[];
                    k?: number;
                    where?: Where;
                    whereDocument?: WhereDocument;
                },
            >,
        >,
    >

  • Parameters

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

    Returns RetrieverReference<
        ZodOptional<
            ZodObject<
                extendShape<
                    { k: ZodOptional<ZodNumber> },
                    {
                        include: ZodOptional<
                            ZodArray<
                                ZodEnum<["documents", "embeddings", "metadatas", "distances"]>,
                                "many",
                            >,
                        >;
                        where: ZodOptional<ZodType<Where, ZodTypeDef, Where>>;
                        whereDocument: ZodOptional<
                            ZodType<WhereDocument, ZodTypeDef, WhereDocument>,
                        >;
                    },
                >,
                "strip",
                ZodTypeAny,
                {
                    include?: ("documents" | "embeddings" | "metadatas" | "distances")[];
                    k?: number;
                    where?: Where;
                    whereDocument?: WhereDocument;
                },
                {
                    include?: ("documents" | "embeddings" | "metadatas" | "distances")[];
                    k?: number;
                    where?: Where;
                    whereDocument?: WhereDocument;
                },
            >,
        >,
    >

Settings

Member Visibility