genkitx-weaviate
    Preparing search index...

    Function weaviateRetriever

    • Creates a Weaviate retriever action.

      This retriever searches for similar documents in a Weaviate collection based on vector similarity.

      Type Parameters

      • EmbedderCustomOptions extends ZodTypeAny

      Parameters

      • ai: Genkit

        Genkit instance

      • collectionName: string

        Name of the Weaviate collection to search

      • client: WeaviateClientWrapper

        Weaviate client wrapper instance

      • embedder: EmbedderArgument<EmbedderCustomOptions>

        The embedder to use for generating query embeddings

      • OptionalembedderOptions: TypeOf<EmbedderCustomOptions>

        Optional embedder options

      Returns RetrieverAction<
          ZodObject<
              { k: ZodOptional<ZodNumber> } & {
                  distance: ZodOptional<ZodNumber>;
                  filters: ZodOptional<ZodType<FilterValue, ZodTypeDef, FilterValue>>;
              },
              "strip",
              ZodTypeAny,
              { distance?: number; filters?: FilterValue; k?: number },
              { distance?: number; filters?: FilterValue; k?: number },
          >,
      >

      A retriever action that can be used with Genkit

      const retriever = weaviateRetriever(ai, 'Documents', client, textEmbedding004);
      const results = await ai.retrieve({
        retriever,
        query: 'What is machine learning?',
        options: { k: 5 }
      });

    Settings

    Member Visibility