• Preparing search index...
  • The search index is not available
Genkit JS API reference
  • Genkit JS API reference
  • @genkit-ai/vertexai
  • vectorsearch
  • vertexAiRetrievers

Function vertexAiRetrievers

  • vertexAiRetrievers<
        EmbedderCustomOptions extends
            z.ZodType<any, any, any, EmbedderCustomOptions>,
    >(
        ai: Genkit,
        params: VertexVectorSearchOptions<EmbedderCustomOptions>,
    ): RetrieverAction<z.ZodTypeAny>[]
  • Creates Vertex AI retrievers.

    This function returns a list of retriever actions for Vertex AI based on the provided vector search options and embedder configurations.

    Type Parameters

    • EmbedderCustomOptions extends z.ZodType<any, any, any, EmbedderCustomOptions>

    Parameters

    • ai: Genkit
    • params: VertexVectorSearchOptions<EmbedderCustomOptions>

      The parameters for creating the retrievers.

    Returns RetrieverAction<z.ZodTypeAny>[]

    • An array of retriever actions.
    • Defined in plugins/vertexai/src/vectorsearch/vector_search/retrievers.ts:36

Settings

Member Visibility
Genkit JS API reference
  • Loading...

Generated using TypeDoc with typedoc-github-theme