Merge branch 'main' into feat/create-context-caching-for-vertexai

Author: falonso81

docs/monitoring.md

@@ -5,7 +5,7 @@ Firebase Genkit is fully instrumented with
 
 ## Telemetry Configuration
 
-Genkit automatically manages tracing and metrics without requiring explicit configuration. You can enable telemetry exports for Firebase or Google Cloud using their respective plugins and helper functions. Using either plugin poweres the [Firebase AI Monitoring dashboard (private preview)](https://forms.gle/Lp5S1NxbZUXsWc457) that has an AI-idiomatic view of telemetry data.
+Genkit automatically manages tracing and metrics without requiring explicit configuration. You can enable telemetry exports for Firebase or Google Cloud using their respective plugins and helper functions. Using either plugin powers the [Genkit Monitoring dashboard](https://console.firebase.google.com/project/_/genai_monitoring) that has an AI-centric view of telemetry data.
 
 ### For Firebase:
 

genkit-tools/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "genkit-cli",
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0-rc.2",
   "description": "CLI for interacting with the Google Genkit AI framework",
   "license": "Apache-2.0",
   "keywords": [

genkit-tools/cli/src/commands/eval-flow.ts

@@ -28,9 +28,12 @@ import {
   runEvaluation,
   runInference,
 } from '@genkit-ai/tools-common/eval';
-import { confirmLlmUse, logger } from '@genkit-ai/tools-common/utils';
+import {
+  confirmLlmUse,
+  loadEvalInference,
+  logger,
+} from '@genkit-ai/tools-common/utils';
 import { Command } from 'commander';
-import { readFile } from 'fs/promises';
 import { runWithManager } from '../utils/manager-utils';
 
 interface EvalFlowRunCliOptions {
@@ -172,8 +175,11 @@ async function readInputs(
       parsedData = JSON.parse(dataField!);
       break;
     case SourceType.FILE:
-      parsedData = JSON.parse(await readFile(input!, 'utf8'));
-      break;
+      try {
+        return await loadEvalInference(input!);
+      } catch (e) {
+        throw new Error(`Error parsing the input from file. Error: ${e}`);
+      }
     case SourceType.DATASET:
       const datasetStore = await getDatasetStore();
       const data = await datasetStore.getDataset(input!);

genkit-tools/cli/src/commands/eval-run.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Action, EvalInput } from '@genkit-ai/tools-common';
+import { Action, EvalInputDataset } from '@genkit-ai/tools-common';
 import {
   EvalExporter,
   getAllEvaluatorActions,
@@ -25,10 +25,10 @@ import {
 import {
   confirmLlmUse,
   generateTestCaseId,
+  loadEvalInputDataset,
   logger,
 } from '@genkit-ai/tools-common/utils';
 import { Command } from 'commander';
-import { readFile } from 'fs/promises';
 import { runWithManager } from '../utils/manager-utils';
 
 interface EvalRunCliOptions {
@@ -92,8 +92,8 @@ export const evalRun = new Command('eval:run')
         }
       }
 
-      const evalDataset: EvalInput[] = JSON.parse(
-        (await readFile(dataset)).toString('utf-8')
+      const evalDataset: EvalInputDataset = (
+        await loadEvalInputDataset(dataset)
       ).map((testCase: any) => ({
         ...testCase,
         testCaseId: testCase.testCaseId || generateTestCaseId(),

genkit-tools/common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@genkit-ai/tools-common",
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0-rc.2",
   "scripts": {
     "compile": "tsc -b ./tsconfig.cjs.json ./tsconfig.esm.json ./tsconfig.types.json",
     "build:clean": "rimraf ./lib",

genkit-tools/common/src/types/eval.ts

@@ -45,18 +45,21 @@ export const ModelInferenceInputJSONSchema = zodToJsonSchema(
   }
 ) as JSONSchema7;
 
+/**
+ * A single sample to be used for inference.
+ **/
+export const EvalInferenceSampleSchema = z.object({
+  testCaseId: z.string().optional(),
+  input: z.any(),
+  reference: z.any().optional(),
+});
+
 /**
  * A set of samples that is ready for inference.
  *
  * This should be used in user-facing surfaces (CLI/API inputs) to accommodate various user input formats. For internal wire-transfer/storage, prefer {@link Dataset}.
  */
-export const EvalInferenceInputSchema = z.array(
-  z.object({
-    testCaseId: z.string().optional(),
-    input: z.any(),
-    reference: z.any().optional(),
-  })
-);
+export const EvalInferenceInputSchema = z.array(EvalInferenceSampleSchema);
 export type EvalInferenceInput = z.infer<typeof EvalInferenceInputSchema>;
 
 /**
@@ -87,6 +90,9 @@ export const EvalInputSchema = z.object({
 });
 export type EvalInput = z.infer<typeof EvalInputSchema>;
 
+export const EvalInputDatasetSchema = z.array(EvalInputSchema);
+export type EvalInputDataset = z.infer<typeof EvalInputDatasetSchema>;
+
 export const EvalMetricSchema = z.object({
   evaluator: z.string(),
   scoreId: z.string().optional(),

genkit-tools/common/src/utils/eval.ts

@@ -15,7 +15,10 @@
  */
 
 import { randomUUID } from 'crypto';
+import { createReadStream } from 'fs';
+import { readFile } from 'fs/promises';
 import * as inquirer from 'inquirer';
+import { createInterface } from 'readline';
 import {
   EvalField,
   EvaluationExtractor,
@@ -25,6 +28,14 @@ import {
   findToolsConfig,
   isEvalField,
 } from '../plugin';
+import {
+  EvalInferenceInput,
+  EvalInferenceInputSchema,
+  EvalInferenceSampleSchema,
+  EvalInputDataset,
+  EvalInputDatasetSchema,
+  EvalInputSchema,
+} from '../types';
 import { Action } from '../types/action';
 import { DocumentData, RetrieverResponse } from '../types/retrievers';
 import { NestedSpanData, TraceData } from '../types/trace';
@@ -222,3 +233,69 @@ export async function getEvalExtractors(
 export function generateTestCaseId() {
   return randomUUID();
 }
+
+/** Load a {@link EvalInferenceInput} file. Supports JSON / JSONL */
+export async function loadEvalInference(
+  fileName: string
+): Promise<EvalInferenceInput> {
+  const isJsonl = fileName.endsWith('.jsonl');
+
+  if (isJsonl) {
+    return await readJsonlForInference(fileName);
+  } else {
+    const parsedData = JSON.parse(await readFile(fileName, 'utf8'));
+    return EvalInferenceInputSchema.parse(parsedData);
+  }
+}
+
+/** Load a {@link Eval} file. Supports JSON / JSONL */
+export async function loadEvalInputDataset(
+  fileName: string
+): Promise<EvalInputDataset> {
+  const isJsonl = fileName.endsWith('.jsonl');
+
+  if (isJsonl) {
+    return await readJsonlForEvaluation(fileName);
+  } else {
+    const parsedData = JSON.parse(await readFile(fileName, 'utf8'));
+    return EvalInputDatasetSchema.parse(parsedData);
+  }
+}
+
+async function readJsonlForInference(
+  fileName: string
+): Promise<EvalInferenceInput> {
+  const lines = await readLines(fileName);
+  const samples: EvalInferenceInput = [];
+  for (const line of lines) {
+    const parsedSample = EvalInferenceSampleSchema.parse(JSON.parse(line));
+    samples.push(parsedSample);
+  }
+  return samples;
+}
+
+async function readJsonlForEvaluation(
+  fileName: string
+): Promise<EvalInputDataset> {
+  const lines = await readLines(fileName);
+  const inputs: EvalInputDataset = [];
+  for (const line of lines) {
+    const parsedSample = EvalInputSchema.parse(JSON.parse(line));
+    inputs.push(parsedSample);
+  }
+  return inputs;
+}
+
+async function readLines(fileName: string): Promise<string[]> {
+  const lines: string[] = [];
+  const fileStream = createReadStream(fileName);
+  const rl = createInterface({
+    input: fileStream,
+    crlfDelay: Infinity,
+  });
+
+  for await (const line of rl) {
+    lines.push(line);
+  }
+  return lines;
+}

genkit-tools/package.json

@@ -25,5 +25,5 @@
       "cross-spawn": "^7.0.5"
     }
   },
-  "packageManager": "pnpm@9.13.2+sha256.ccce81bf7498c5f0f80e31749c1f8f03baba99d168f64590fc7e13fad3ea1938"
+  "packageManager": "pnpm@9.15.1+sha256.9e534e70afef06374f6126b44bda5760947135ce16a30aef1010e965fb7e3e3e"
 }

genkit-tools/telemetry-server/package.json

@@ -7,7 +7,7 @@
     "genai",
     "generative-ai"
   ],
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0-rc.2",
   "type": "commonjs",
   "scripts": {
     "compile": "tsc -b ./tsconfig.cjs.json ./tsconfig.esm.json ./tsconfig.types.json",

js/ai/package.json

@@ -7,7 +7,7 @@
     "genai",
     "generative-ai"
   ],
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0-rc.2",
   "type": "commonjs",
   "scripts": {
     "check": "tsc",

js/ai/src/chat.ts

@@ -33,7 +33,7 @@ import {
   Session,
   SessionStore,
   runWithSession,
-} from './session';
+} from './session.js';
 
 export const MAIN_THREAD = 'main';
 
@@ -242,7 +242,7 @@ export class Chat {
     return this._messages ?? [];
   }
 
-  async updateMessages(messages: MessageData[]): Promise<void> {
+  private async updateMessages(messages: MessageData[]): Promise<void> {
     this._messages = messages;
     await this.session.updateMessages(this.threadName, messages);
   }

js/ai/src/prompt.ts

@@ -27,6 +27,7 @@ import {
   GenerateRequestSchema,
   GenerateResponseChunkSchema,
   ModelArgument,
+  ModelMiddleware,
 } from './model.js';
 import { ToolAction } from './tool.js';
 
@@ -51,6 +52,7 @@ export type PromptAction<I extends z.ZodTypeAny = z.ZodTypeAny> = Action<
       type: 'prompt';
     };
   };
+  __config: PromptConfig;
 };
 
 /**
@@ -62,6 +64,7 @@ export interface PromptConfig<I extends z.ZodTypeAny = z.ZodTypeAny> {
   inputSchema?: I;
   inputJsonSchema?: JSONSchema7;
   metadata?: Record<string, any>;
+  use?: ModelMiddleware[];
 }
 
 /**
@@ -147,12 +150,16 @@ export function definePrompt<I extends z.ZodTypeAny>(
   const a = defineAction(
     registry,
     {
-      ...config,
+      name: config.name,
+      inputJsonSchema: config.inputJsonSchema,
+      inputSchema: config.inputSchema,
+      description: config.description,
       actionType: 'prompt',
       metadata: { ...(config.metadata || { prompt: {} }), type: 'prompt' },
     },
     fn
   );
+  (a as PromptAction<I>).__config = config;
   return a as PromptAction<I>;
 }
 

js/ai/src/retriever.ts

@@ -370,6 +370,7 @@ function itemToMetadata(
   if (Array.isArray(options.metadata) && typeof item === 'object') {
     const out: Record<string, any> = {};
     options.metadata.forEach((key) => (out[key] = item[key]));
+    return out;
   }
   if (typeof options.metadata === 'function') return options.metadata(item);
   if (!options.metadata && typeof item === 'object') {

js/ai/src/session.ts

@@ -17,7 +17,7 @@
 import { z } from '@genkit-ai/core';
 import { Registry } from '@genkit-ai/core/registry';
 import { v4 as uuidv4 } from 'uuid';
-import { Chat, ChatOptions, MAIN_THREAD, PromptRenderOptions } from './chat';
+import { Chat, ChatOptions, MAIN_THREAD, PromptRenderOptions } from './chat.js';
 import {
   ExecutablePrompt,
   GenerateOptions,

js/core/package.json

@@ -7,7 +7,7 @@
     "genai",
     "generative-ai"
   ],
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0-rc.2",
   "type": "commonjs",
   "scripts": {
     "check": "tsc",

js/genkit/package.json

@@ -7,7 +7,7 @@
     "genai",
     "generative-ai"
   ],
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0-rc.2",
   "type": "commonjs",
   "main": "./lib/cjs/index.js",
   "scripts": {

js/genkit/src/client/client.ts

@@ -22,7 +22,7 @@ const __flowStreamDelimiter = '\n\n';
  * For example:
  *
  * ```js
- * import { streamFlow } from '@genkit-ai/core/flow-client';
+ * import { streamFlow } from 'genkit/client';
  *
  * const response = streamFlow({
  *   url: 'https://my-flow-deployed-url',