@genkit-ai/vertexai/lib/rerankers/legacy/reranker.d.ts

Genkit AI framework plugin for Google Cloud Vertex AI APIs including Gemini APIs, Imagen, and more.

import * as genkit from 'genkit';
import { Genkit } from 'genkit';
import * as zod from 'zod';
import { VertexRerankOptions } from './types.js';
import 'google-auth-library';
import '../../types-B3i-Lt7D.js';
import '@google-cloud/vertexai';
import 'genkit/model';

/**
 * Creates Vertex AI rerankers.
 *
 * This function creates and registers rerankers for the specified models.
 *
 * @param {VertexRerankOptions<EmbedderCustomOptions>} options - The parameters for creating the rerankers.
 * @returns {Promise<void>}
 * @deprecated please use vertexRerankers instead
 */
declare function vertexAiRerankers(ai: Genkit, options: VertexRerankOptions): Promise<void>;
/**
 * Creates a reference to a Vertex AI reranker.
 *
 * @param {Object} params - The parameters for the reranker reference.
 * @param {string} [params.displayName] - An optional display name for the reranker.
 * @returns {Object} - The reranker reference object.
 * @deprecated please user vertexRerankerRef instead
 */
declare const vertexAiRerankerRef: (params: {
    rerankerName: string;
    displayName?: string;
}) => genkit.RerankerReference<zod.ZodOptional<zod.ZodObject<{
    k: zod.ZodOptional<zod.ZodNumber>;
    model: zod.ZodOptional<zod.ZodString>;
    location: zod.ZodOptional<zod.ZodString>;
}, "strip", zod.ZodTypeAny, {
    location?: string | undefined;
    model?: string | undefined;
    k?: number | undefined;
}, {
    location?: string | undefined;
    model?: string | undefined;
    k?: number | undefined;
}>>>;

export { vertexAiRerankerRef, vertexAiRerankers };