Skip to content

refactor(plugins/checks): migrate to v2 API #3541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+30 −24
Open

refactor(plugins/checks): migrate to v2 API #3541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
acd9178
refactor(checks): migrate to v2 API
CorieW Sep 10, 2025
4a40785
chore: format
CorieW Sep 11, 2025
0fb5198
fix(plugins/checks): typo in error message for missing projectId
CorieW Sep 17, 2025
a4d9063
fix(plugins/checks): adjust based on testing
CorieW Sep 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions js/plugins/checks/src/evaluation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@
* limitations under the License.
*/

import { z, type EvaluatorAction, type Genkit } from 'genkit';
import { z, type EvaluatorAction } from 'genkit';
import type { BaseEvalDataPoint } from 'genkit/evaluator';
import { evaluator } from 'genkit/plugin';
import { runInNewSpan } from 'genkit/tracing';
import type { GoogleAuth } from 'google-auth-library';
import {
Expand All @@ -25,7 +26,6 @@ import {
} from './metrics';

export function checksEvaluators(
ai: Genkit,
auth: GoogleAuth,
metrics: ChecksEvaluationMetric[],
projectId: string
Expand All @@ -42,7 +42,7 @@ export function checksEvaluators(
}
);

return createPolicyEvaluator(projectId, auth, ai, policy_configs);
return createPolicyEvaluator(projectId, auth, policy_configs);
}

const ResponseSchema = z.object({
Expand All @@ -58,10 +58,9 @@ const ResponseSchema = z.object({
function createPolicyEvaluator(
projectId: string,
auth: GoogleAuth,
ai: Genkit,
policy_config: ChecksEvaluationMetricConfig[]
): EvaluatorAction {
return ai.defineEvaluator(
return evaluator(
{
name: 'checks/guardrails',
displayName: 'checks/guardrails',
Expand All @@ -83,7 +82,6 @@ function createPolicyEvaluator(
};

const response = await checksEvalInstance(
ai,
projectId,
auth,
partialRequest,
Expand All @@ -109,14 +107,12 @@ function createPolicyEvaluator(
}

async function checksEvalInstance<ResponseType extends z.ZodTypeAny>(
ai: Genkit,
projectId: string,
auth: GoogleAuth,
partialRequest: any,
responseSchema: ResponseType
): Promise<z.infer<ResponseType>> {
return await runInNewSpan(
ai,
{
metadata: {
name: 'EvaluationService#evaluateInstances',
Expand Down
42 changes: 26 additions & 16 deletions js/plugins/checks/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@
* limitations under the License.
*/

import type { Genkit } from 'genkit';
import { logger } from 'genkit/logging';
import type { ModelMiddleware } from 'genkit/model';
import { genkitPlugin, type GenkitPlugin } from 'genkit/plugin';
import { genkitPluginV2, type GenkitPluginV2 } from 'genkit/plugin';
import { ActionType } from 'genkit/registry';
import { GoogleAuth, type GoogleAuthOptions } from 'google-auth-library';
import { checksEvaluators } from './evaluation.js';
import {
Expand Down Expand Up @@ -47,23 +47,33 @@ const CHECKS_OAUTH_SCOPE = 'https://www.googleapis.com/auth/checks';
/**
* Add Google Checks evaluators.
*/
export function checks(options?: PluginOptions): GenkitPlugin {
return genkitPlugin('checks', async (ai: Genkit) => {
const googleAuth = inititializeAuth(options?.googleAuthOptions);
export function checks(options?: PluginOptions): GenkitPluginV2 {
const googleAuth = inititializeAuth(options?.googleAuthOptions);

const projectId = options?.projectId || (await googleAuth.getProjectId());
const projectId = options?.projectId || googleAuth.getProjectId();

if (!projectId) {
throw new Error(
`Checks Plugin is missing the 'projectId' configuration. Please set the 'GCLOUD_PROJECT' environment variable or explicitly pass 'projectId' into genkit config.`
);
}
if (!projectId) {
throw new Error(
`Checks Plugin is missing the 'projectId' configuration. Please set the 'GCLOUD_PROJECT' environment variable or explicitly pass 'projectId' into Genkit config.`
);
}

const metrics =
options?.evaluation && options.evaluation.metrics.length > 0
? options.evaluation.metrics
: [];
checksEvaluators(ai, googleAuth, metrics, projectId);
const metrics =
options?.evaluation && options.evaluation.metrics.length > 0
? options.evaluation.metrics
: [];

return genkitPluginV2({
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what happens if metrics is empty now?

name: 'checks',
init: async () => {
return [checksEvaluators(googleAuth, metrics, await projectId)];
},
resolve: async (actionType: ActionType, name: string) => {
return checksEvaluators(googleAuth, metrics, await projectId);
},
list: async () => {
return [checksEvaluators(googleAuth, metrics, await projectId).__action];
},
});
}

Expand Down