Function chromaRetrieverRef

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