genkit/src/reranker.ts

Genkit AI framework

/**
 * @license
 *
 * Copyright 2024 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.
 */

/**
 * Reranker types — `RankedDocument`, reference helpers, and schemas for
 * building reranker plugins.
 *
 * ```ts
 * import { RankedDocument, rerankerRef } from 'genkit/reranker';
 * ```
 *
 * @module reranker
 */

export {
  CommonRerankerOptionsSchema,
  RankedDocument,
  RankedDocumentDataSchema,
  RerankerInfoSchema,
  rerankerRef,
  type RankedDocumentData,
  type RerankerAction,
  type RerankerArgument,
  type RerankerInfo,
  type RerankerParams,
  type RerankerReference,
} from '@genkit-ai/ai/reranker';