Merge pull request #21 from firefliesai/chore-sc-70927-add-gemini-vertex-api-support

feat: add gemini vertex api support

Author: grimmerk

CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to Schema Forge will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.2] - 2025-03-25
+
+1. Publish `jsonSchemaToGeminiOldTool`, `jsonSchemaToGeminiOldResponseSchema` that whould be published in 1.0.0.
+2. Support the tool format and responseSchema format of google vertex API, `@google-cloud/vertexai`. Supply the following functions
+   1. `jsonSchemaToGeminiVertexTool`
+   2. `jsonSchemaToGeminiVertexResponseSchema`
+   3. `classToGeminiVertexResponseSchema`
+   4. `classToGeminiVertexTool`
+
 ## [1.0.1] - 2025-03-25
 
 1. Improve README

README.md

@@ -287,25 +287,33 @@ if (message.content[0].type === 'tool_use') {
 #### Google Gemini
 
 ```typescript
-import { classToGeminiTool, classToGeminiOldTool } from '@firefliesai/schema-forge';
+import { classToGeminiTool, classToGeminiOldTool, classToGeminiVertexTool } from '@firefliesai/schema-forge';
 
 /** Use with @google/genai */
-const tool = classToGeminiTool(UserInput);
+const geminiTool = classToGeminiTool(UserInput);
 const response = await geminiClient.models.generateContent({
   model: 'gemini-2.0-flash-001',
   contents: userMessage,
   config: {
-    tools: [{ functionDeclarations: [tool] }],
+    tools: [{ functionDeclarations: [geminiTool] }],
   },
 });
 
 /** Use with Google @google/generative-ai */
-const geminiTool = classToGeminiOldTool(UserInput);
+const geminiOldTool = classToGeminiOldTool(UserInput);
 const model = geminiOldClient.getGenerativeModel({
   model: "gemini-2.0-flash-001",
-  tools: { functionDeclarations: [geminiTool] },
+  tools: { functionDeclarations: [geminiOldTool] },
 });
 const result = await model.generateContent([userMessage]);
+
+/** Use with Google @google-cloud/vertexai */
+const geminiVertexTool = classToGeminiVertexTool(UserInput);
+const vertexModel = geminiOldClient.getGenerativeModel({
+  model: "gemini-2.0-flash-001",
+  tools: { functionDeclarations: [geminiVertexTool] },
+});
+const resp = await generativeModel.generateContent(prompt);
 ```
 
 ## Advanced Usage
@@ -678,6 +686,8 @@ roles: string[];
 - `classToGeminiResponseSchema(target, options?)`: Generates Gemini response schema for new `@google/genai` API
 - `classToGeminiOldTool(target, options?)`: Generates Google Gemini tool format for legacy `@google/generative-ai` API
 - `classToGeminiOldResponseSchema(target, options?)`: Generates Gemini response schema for legacy `@google/generative-ai` API
+- `classToGeminiVertexTool(target, options?)`: Generates Google Gemini tool format for `@google-cloud/vertexai` API *(Note: functionality implemented but not verified with real API calls)*
+- `classToGeminiVertexResponseSchema(target, options?)`: Generates Gemini response schema for `@google-cloud/vertexai` API *(Note: functionality implemented but not verified with real API calls)*
 
 #### JSON Schema to LLM Format Converters
 
@@ -686,9 +696,13 @@ roles: string[];
 - `jsonSchemaToOpenAIResponseFormat(schema, metadata, options?)`: Converts JSON Schema to OpenAI response format for Chat Completions API
 - `jsonSchemaToOpenAIResponseApiTextSchema(schema, metadata, options?)`: Converts JSON Schema to OpenAI text format for Response API
 - `jsonSchemaToAnthropicTool(schema, metadata)`: Converts JSON Schema to Anthropic Claude tool format
-- `jsonSchemaToGeminiTool(schema, metadata)`: Converts JSON Schema to Google Gemini tool format
-- `jsonSchemaToGeminiResponseSchema(schema, metadata)`: Converts JSON Schema to Gemini response schema format
-
+- `jsonSchemaToGeminiTool(schema, metadata)`: Converts JSON Schema to Google Gemini tool format for new `@google/genai` API
+- `jsonSchemaToGeminiResponseSchema(schema, metadata)`: Converts JSON Schema to Gemini response schema format for new `@google/genai` API
+- `jsonSchemaToGeminiOldTool(schema, metadata)`: Converts JSON Schema to Google Gemini old tool format for legacy `@google/generative-ai` API
+- `jsonSchemaToGeminiOldResponseSchema(schema, metadata)`: Converts JSON Schema to Gemini old response schema format for legacy `@google/generative-ai` API
+- `jsonSchemaToGeminiVertexTool(schema, metadata)`: Converts JSON Schema to Gemini tool format for `@google-cloud/vertexai` API *(Note: functionality implemented but not verified with real API calls)*
+- `jsonSchemaToGeminiVertexResponseSchema(schema, metadata)`: Converts JSON Schema to Gemini response schema format for `@google-cloud/vertexai` API *(Note: functionality implemented but not verified with real API calls)*
+ 
 #### LLM Format to JSON Schema Converters
 
 - `openAIToolToJsonSchema(openAITool)`: Extracts JSON Schema and metadata from an OpenAI Chat Completions API tool
@@ -821,13 +835,14 @@ Google provides multiple API packages for working with Gemini models. Schema For
 3. **Google Vertex AI**: `@google-cloud/vertexai`
    - Enterprise API for Google Cloud Platform
    - Requires GCP project and location settings
-   - Uses the same formats as the new `@google/genai` library
+   - Use `classToGeminiVertexTool` and `classToGeminiVertexResponseSchema`
+   - **Note**: Vertex AI support is implemented but not verified with actual API calls yet
+   - **Important**: Google may eventually deprecate this API in favor of `@google/genai`
    - Example:
      ```typescript
      import { VertexAI } from '@google-cloud/vertexai';
      const vertexAI = new VertexAI({project, location});
-     // Same format which is supposed to works, but not verified yet. 
-     const tool = classToGeminiTool(MyClass); 
+     const tool = classToGeminiVertexTool(MyClass); 
      ```
 
 #### Anthropic Claude

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firefliesai/schema-forge",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "main": "dist/lib/index.js",
   "types": "dist/lib/index.d.ts",
   "exports": {
@@ -95,4 +95,4 @@
   "peerDependencies": {
     "reflect-metadata": "^0.2.2"
   }
-}
+}

src/lib/index.ts

@@ -20,14 +20,20 @@ export {
   classToGeminiOldTool,
   classToGeminiResponseSchema,
   classToGeminiTool,
+  classToGeminiVertexResponseSchema,
+  classToGeminiVertexTool,
   classToOpenAIResponseApiTextSchema,
   classToOpenAIResponseApiTool,
   classToOpenAIResponseFormatJsonSchema,
   classToOpenAITool,
   // Direct JSON Schema converters
   jsonSchemaToAnthropicTool,
+  jsonSchemaToGeminiOldResponseSchema,
+  jsonSchemaToGeminiOldTool,
   jsonSchemaToGeminiResponseSchema,
   jsonSchemaToGeminiTool,
+  jsonSchemaToGeminiVertexResponseSchema,
+  jsonSchemaToGeminiVertexTool,
   jsonSchemaToOpenAIResponseApiTextSchema,
   jsonSchemaToOpenAIResponseApiTool,
   jsonSchemaToOpenAIResponseFormat,

src/lib/llm-formats.ts

@@ -11,6 +11,8 @@ import {
   GeminiResponseSchemaOptions,
   GeminiToolFunction,
   GeminiToolOptions,
+  GeminiVertexResponseSchema,
+  GeminiVertexToolFunction,
   JSONSchemaDefinition,
   OpenAIResponseApiTextSchema,
   OpenAIResponseApiToolFunction,
@@ -231,6 +233,14 @@ export function jsonSchemaToGeminiOldTool(
   };
 }
 
+/** @google-cloud/vertexai */
+export function jsonSchemaToGeminiVertexTool(
+  schema: JSONSchemaDefinition,
+  metadata: { name: string; description?: string },
+): GeminiVertexToolFunction {
+  return jsonSchemaToGeminiTool(schema, metadata) as unknown as GeminiVertexToolFunction;
+}
+
 /**
  * Converts a JSON Schema to Gemini response schema format (@google/genai)
  *
@@ -272,6 +282,17 @@ export function jsonSchemaToGeminiOldResponseSchema(
   };
 }
 
+// @google-cloud/vertexai
+export function jsonSchemaToGeminiVertexResponseSchema(
+  schema: JSONSchemaDefinition,
+  metadata: { description?: string },
+): GeminiVertexResponseSchema {
+  return jsonSchemaToGeminiResponseSchema(
+    schema,
+    metadata,
+  ) as unknown as GeminiVertexResponseSchema;
+}
+
 /**
  * Creates an OpenAI-compatible tool function from a class
  *
@@ -535,6 +556,14 @@ export function classToGeminiOldTool<T extends object>(
   });
 }
 
+// @google-cloud/vertexai
+export function classToGeminiVertexTool<T extends object>(
+  target: new (...args: any[]) => T,
+  options?: GeminiToolOptions<T>,
+): GeminiVertexToolFunction {
+  return classToGeminiTool(target, options) as unknown as GeminiVertexToolFunction;
+}
+
 /**
  * Creates an Anthropic-compatible tool function from a class
  *
@@ -643,6 +672,14 @@ export function classToGeminiOldResponseSchema<T extends object>(
   });
 }
 
+/** @google-cloud/vertexai */
+export function classToGeminiVertexResponseSchema<T extends object>(
+  target: new (...args: any[]) => T,
+  options?: GeminiResponseSchemaOptions<T>,
+): GeminiVertexResponseSchema {
+  return classToGeminiResponseSchema(target, options) as unknown as GeminiVertexResponseSchema;
+}
+
 /**
  * Extracts JSON Schema and metadata from an OpenAI Chat Completions API tool format
  *

src/lib/types.ts

@@ -1,6 +1,7 @@
 /**
  * Types for schema-forge
  */
+import { SchemaType as SchemaVertexType } from './vertex-api.type';
 
 /** @google/generative-ai */
 export enum SchemaType {
@@ -128,6 +129,20 @@ export interface GeminiOldToolFunction {
   };
 }
 
+// @google-cloud/vertexai
+export interface GeminiVertexToolFunction {
+  name: string;
+  description?: string;
+  parameters: {
+    // json schema like structure,
+    // Google Gemini (@google-cloud/vertexai) prefers capital 'OBJECT' instead of 'object'
+    type: SchemaVertexType.OBJECT;
+    description?: string;
+    properties: Record<string, any>;
+    required?: string[];
+  };
+}
+
 /** Google Gemini (@google/genai):
  * json schema like, except object becoming capital 'OBJECT  */
 export interface GeminiResponseSchema {
@@ -145,6 +160,14 @@ export interface GeminiOldResponseSchema {
   required?: string[];
 }
 
+// @google-cloud/vertexai
+export interface GeminiVertexResponseSchema {
+  description?: string;
+  type: SchemaVertexType.OBJECT;
+  properties: Record<string, any>;
+  required?: string[];
+}
+
 // Anthropic Tool Function format
 export interface AnthropicToolFunction {
   name: string;

src/lib/vertex-api.type.ts

@@ -0,0 +1,4 @@
+// @google-cloud/vertexai
+export enum SchemaType {
+  OBJECT = 'OBJECT',
+}