import { Genkit, Action } from 'genkit'; import { GoogleAuth } from 'google-auth-library'; /** * 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. */ /** * Vertex AI Evaluation metrics. See API documentation for more information. * https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/evaluation#parameter-list */ declare enum VertexAIEvaluationMetricType { BLEU = "BLEU", ROUGE = "ROUGE", FLUENCY = "FLEUNCY", SAFETY = "SAFETY", GROUNDEDNESS = "GROUNDEDNESS", SUMMARIZATION_QUALITY = "SUMMARIZATION_QUALITY", SUMMARIZATION_HELPFULNESS = "SUMMARIZATION_HELPFULNESS", SUMMARIZATION_VERBOSITY = "SUMMARIZATION_VERBOSITY" } /** * Evaluation metric config. Use `metricSpec` to define the behavior of the metric. * The value of `metricSpec` will be included in the request to the API. See the API documentation * for details on the possible values of `metricSpec` for each metric. * https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/evaluation#parameter-list */ type VertexAIEvaluationMetricConfig = { type: VertexAIEvaluationMetricType; metricSpec: any; }; type VertexAIEvaluationMetric = VertexAIEvaluationMetricType | VertexAIEvaluationMetricConfig; declare function vertexEvaluators(ai: Genkit, auth: GoogleAuth, metrics: VertexAIEvaluationMetric[], projectId: string, location: string): Action[]; export { type VertexAIEvaluationMetric, type VertexAIEvaluationMetricConfig, VertexAIEvaluationMetricType, vertexEvaluators };