@genkit-ai/vertexai/lib/rerankers/v2/types.d.mts

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

import { GoogleAuthOptions, GoogleAuth } from 'google-auth-library';

/**
 * Copyright 2025 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

interface VertexRerankerPluginOptions {
    googleAuth?: GoogleAuthOptions;
    location?: string;
    projectId?: string;
}
interface VertexRerankerClientOptions {
    authClient: GoogleAuth;
    location?: string;
    projectId: string;
}
type RerankRequestRecord = {
    id: string;
    title?: string;
    content: string;
};
type RerankRequest = {
    model: string;
    query: string;
    records: RerankRequestRecord[];
    topN?: number;
    ignoreRecordDetailsInResponse?: boolean;
};
type RerankResponseRecord = RerankRequestRecord & {
    score: number;
};
type RerankResponse = {
    records: RerankResponseRecord[];
};

export type { RerankRequest, RerankRequestRecord, RerankResponse, RerankResponseRecord, VertexRerankerClientOptions, VertexRerankerPluginOptions };