Function vertexAiRetrieverRef

Creates a reference to a Vertex AI retriever.

  • vertexAiRetrieverRef(
        params: { displayName?: string; indexId: string },
    ): RetrieverReference<
        ZodOptional<
            ZodOptional<
                ZodObject<
                    extendShape<{ k: ZodOptional<ZodNumber> }, {}>,
                    "strip",
                    ZodTypeAny,
                    { k?: number },
                    { k?: number },
                >,
            >,
        >,
    >

  • Parameters

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

      The parameters for the retriever reference.

      • OptionaldisplayName?: string

        An optional display name for the retriever.

      • indexId: string

        The ID of the Vertex AI index.

    Returns RetrieverReference<
        ZodOptional<
            ZodOptional<
                ZodObject<
                    extendShape<{ k: ZodOptional<ZodNumber> }, {}>,
                    "strip",
                    ZodTypeAny,
                    { k?: number },
                    { k?: number },
                >,
            >,
        >,
    >

    • The retriever reference object.

Settings

Member Visibility