@genkit-ai/checks/lib/index.d.ts

Google Checks AI Safety plugins for classifying the safety of text against Checks AI safety policies.

import { ModelMiddleware } from 'genkit/model';
import { GenkitPlugin } from 'genkit/plugin';
import { GoogleAuthOptions } from 'google-auth-library';
import { ChecksEvaluationMetric } from './metrics.js';
export { ChecksEvaluationMetricType } from './metrics.js';

/**
 * 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.
 */

interface PluginOptions {
    /** The Google Cloud project id to call. Must have quota for the Checks API. */
    projectId?: string;
    /** Provide custom authentication configuration for connecting to Checks API. */
    googleAuthOptions?: GoogleAuthOptions;
    /** Configure Checks evaluators. */
    evaluation?: {
        metrics: ChecksEvaluationMetric[];
    };
}
/**
 * Add Google Checks evaluators.
 */
declare function checks(options?: PluginOptions): GenkitPlugin;
declare function checksMiddleware(options: {
    authOptions: GoogleAuthOptions;
    metrics: ChecksEvaluationMetric[];
}): ModelMiddleware;

export { type PluginOptions, checks, checksMiddleware, checks as default };