-
Notifications
You must be signed in to change notification settings - Fork 93
/
gemini.ts
659 lines (615 loc) · 18.2 KB
/
gemini.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
/**
* 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.
*/
import { extractJson } from '@genkit-ai/ai/extract';
import {
CandidateData,
defineModel,
GenerationCommonConfigSchema,
getBasicUsageStats,
MediaPart,
MessageData,
ModelAction,
ModelMiddleware,
modelRef,
ModelReference,
Part,
ToolDefinitionSchema,
ToolRequestPart,
ToolResponsePart,
} from '@genkit-ai/ai/model';
import {
downloadRequestMedia,
simulateSystemPrompt,
} from '@genkit-ai/ai/model/middleware';
import { GENKIT_CLIENT_HEADER } from '@genkit-ai/core';
import {
FileDataPart,
FunctionCallPart,
FunctionDeclaration,
FunctionDeclarationSchemaType,
FunctionResponsePart,
GenerateContentCandidate as GeminiCandidate,
Content as GeminiMessage,
Part as GeminiPart,
GenerateContentResponse,
GenerationConfig,
GoogleGenerativeAI,
InlineDataPart,
RequestOptions,
StartChatParams,
Tool,
} from '@google/generative-ai';
import process from 'process';
import z from 'zod';
const SafetySettingsSchema = z.object({
category: z.enum([
'HARM_CATEGORY_UNSPECIFIED',
'HARM_CATEGORY_HATE_SPEECH',
'HARM_CATEGORY_SEXUALLY_EXPLICIT',
'HARM_CATEGORY_HARASSMENT',
'HARM_CATEGORY_DANGEROUS_CONTENT',
]),
threshold: z.enum([
'BLOCK_LOW_AND_ABOVE',
'BLOCK_MEDIUM_AND_ABOVE',
'BLOCK_ONLY_HIGH',
'BLOCK_NONE',
]),
});
const GeminiConfigSchema = GenerationCommonConfigSchema.extend({
safetySettings: z.array(SafetySettingsSchema).optional(),
codeExecution: z.union([z.boolean(), z.object({}).strict()]).optional(),
});
export const geminiPro = modelRef({
name: 'googleai/gemini-pro',
info: {
label: 'Google AI - Gemini Pro',
supports: {
multiturn: true,
media: false,
tools: true,
systemRole: true,
},
versions: ['gemini-1.0-pro', 'gemini-1.0-pro-latest', 'gemini-1.0-pro-001'],
},
configSchema: GeminiConfigSchema,
});
/**
* @deprecated Use `gemini15Pro`, `gemini15Flash`, or `gemini15flash8B` instead.
*/
export const geminiProVision = modelRef({
name: 'googleai/gemini-pro-vision',
info: {
label: 'Google AI - Gemini Pro Vision',
// none declared on https://ai.google.dev/models/gemini#model-variations
versions: [],
supports: {
multiturn: true,
media: true,
tools: false,
systemRole: false,
},
stage: 'deprecated',
},
configSchema: GeminiConfigSchema,
});
export const gemini15Pro = modelRef({
name: 'googleai/gemini-1.5-pro-latest',
info: {
label: 'Google AI - Gemini 1.5 Pro',
supports: {
multiturn: true,
media: true,
tools: true,
systemRole: true,
output: ['text', 'json'],
},
versions: [
'gemini-1.5-pro',
'gemini-1.5-pro-001',
'gemini-1.5-pro-002',
'gemini-1.5-pro-exp-0827',
],
},
configSchema: GeminiConfigSchema,
});
export const gemini15Flash = modelRef({
name: 'googleai/gemini-1.5-flash-latest',
info: {
label: 'Google AI - Gemini 1.5 Flash',
supports: {
multiturn: true,
media: true,
tools: true,
systemRole: true,
output: ['text', 'json'],
},
versions: [
'gemini-1.5-flash',
'gemini-1.5-flash-001',
'gemini-1.5-flash-002',
'gemini-1.5-flash-8b-exp-0924',
'gemini-1.5-flash-8b-exp-0827',
'gemini-1.5-flash-exp-0827',
],
},
configSchema: GeminiConfigSchema,
});
export const gemini15Flash8B = modelRef({
name: 'googleai/gemini-1.5-flash-8b-latest',
info: {
label: 'Google AI - Gemini 1.5 Flash-8B',
supports: {
multiturn: true,
media: true,
tools: true,
systemRole: true,
output: ['text', 'json'],
},
versions: ['gemini-1.5-flash-8b', 'gemini-1.5-flash-8b-001'],
},
configSchema: GeminiConfigSchema,
});
export const geminiUltra = modelRef({
name: 'googleai/gemini-ultra',
info: {
label: 'Google AI - Gemini Ultra',
versions: [],
supports: {
multiturn: true,
media: false,
tools: true,
systemRole: true,
},
},
configSchema: GeminiConfigSchema,
});
export const SUPPORTED_V1_MODELS: Record<
string,
ModelReference<z.ZodTypeAny>
> = {
'gemini-pro': geminiPro,
'gemini-pro-vision': geminiProVision,
// 'gemini-ultra': geminiUltra,
};
export const SUPPORTED_V15_MODELS: Record<
string,
ModelReference<z.ZodTypeAny>
> = {
'gemini-1.5-pro-latest': gemini15Pro,
'gemini-1.5-flash-latest': gemini15Flash,
'gemini-1.5-flash-8b-latest': gemini15Flash8B,
};
const SUPPORTED_MODELS = {
...SUPPORTED_V1_MODELS,
...SUPPORTED_V15_MODELS,
};
function toGeminiRole(
role: MessageData['role'],
model?: ModelReference<z.ZodTypeAny>
): string {
switch (role) {
case 'user':
return 'user';
case 'model':
return 'model';
case 'system':
if (model && SUPPORTED_V15_MODELS[model.name]) {
// We should have already pulled out the supported system messages,
// anything remaining is unsupported; throw an error.
throw new Error(
'system role is only supported for a single message in the first position'
);
} else {
throw new Error('system role is not supported');
}
case 'tool':
return 'function';
default:
return 'user';
}
}
function convertSchemaProperty(property) {
if (!property) {
return null;
}
if (property.type === 'object') {
const nestedProperties = {};
Object.keys(property.properties).forEach((key) => {
nestedProperties[key] = convertSchemaProperty(property.properties[key]);
});
return {
type: FunctionDeclarationSchemaType.OBJECT,
properties: nestedProperties,
required: property.required,
};
} else if (property.type === 'array') {
return {
type: FunctionDeclarationSchemaType.ARRAY,
items: convertSchemaProperty(property.items),
};
} else {
return {
type: FunctionDeclarationSchemaType[property.type.toUpperCase()],
};
}
}
function toGeminiTool(
tool: z.infer<typeof ToolDefinitionSchema>
): FunctionDeclaration {
const declaration: FunctionDeclaration = {
name: tool.name.replace(/\//g, '__'), // Gemini throws on '/' in tool name
description: tool.description,
parameters: convertSchemaProperty(tool.inputSchema),
};
return declaration;
}
function toInlineData(part: MediaPart): InlineDataPart {
const dataUrl = part.media.url;
const b64Data = dataUrl.substring(dataUrl.indexOf(',')! + 1);
const contentType =
part.media.contentType ||
dataUrl.substring(dataUrl.indexOf(':')! + 1, dataUrl.indexOf(';'));
return { inlineData: { mimeType: contentType, data: b64Data } };
}
function toFileData(part: MediaPart): FileDataPart {
if (!part.media.contentType)
throw new Error(
'Must supply a `contentType` when sending File URIs to Gemini.'
);
return {
fileData: { mimeType: part.media.contentType, fileUri: part.media.url },
};
}
function fromInlineData(inlinePart: InlineDataPart): MediaPart {
// Check if the required properties exist
if (
!inlinePart.inlineData ||
!inlinePart.inlineData.hasOwnProperty('mimeType') ||
!inlinePart.inlineData.hasOwnProperty('data')
) {
throw new Error('Invalid InlineDataPart: missing required properties');
}
const { mimeType, data } = inlinePart.inlineData;
// Combine data and mimeType into a data URL
const dataUrl = `data:${mimeType};base64,${data}`;
return {
media: {
url: dataUrl,
contentType: mimeType,
},
};
}
function toFunctionCall(part: ToolRequestPart): FunctionCallPart {
if (!part?.toolRequest?.input) {
throw Error('Invalid ToolRequestPart: input was missing.');
}
return {
functionCall: {
name: part.toolRequest.name,
args: part.toolRequest.input,
},
};
}
function fromFunctionCall(part: FunctionCallPart): ToolRequestPart {
if (!part.functionCall) {
throw Error('Invalid FunctionCallPart');
}
return {
toolRequest: {
name: part.functionCall.name,
input: part.functionCall.args,
},
};
}
function toFunctionResponse(part: ToolResponsePart): FunctionResponsePart {
if (!part?.toolResponse?.output) {
throw Error('Invalid ToolResponsePart: output was missing.');
}
return {
functionResponse: {
name: part.toolResponse.name,
response: {
name: part.toolResponse.name,
content: part.toolResponse.output,
},
},
};
}
function fromFunctionResponse(part: FunctionResponsePart): ToolResponsePart {
if (!part.functionResponse) {
throw new Error('Invalid FunctionResponsePart.');
}
return {
toolResponse: {
name: part.functionResponse.name.replace(/__/g, '/'), // restore slashes
output: part.functionResponse.response,
},
};
}
function fromExecutableCode(part: GeminiPart): Part {
if (!part.executableCode) {
throw new Error('Invalid GeminiPart: missing executableCode');
}
return {
custom: {
executableCode: {
language: part.executableCode.language,
code: part.executableCode.code,
},
},
};
}
function fromCodeExecutionResult(part: GeminiPart): Part {
if (!part.codeExecutionResult) {
throw new Error('Invalid GeminiPart: missing codeExecutionResult');
}
return {
custom: {
codeExecutionResult: {
outcome: part.codeExecutionResult.outcome,
output: part.codeExecutionResult.output,
},
},
};
}
function toCustomPart(part: Part): GeminiPart {
if (!part.custom) {
throw new Error('Invalid GeminiPart: missing custom');
}
if (part.custom.codeExecutionResult) {
return { codeExecutionResult: part.custom.codeExecutionResult };
}
if (part.custom.executableCode) {
return { executableCode: part.custom.executableCode };
}
throw new Error('Unsupported Custom Part type');
}
function toGeminiPart(part: Part): GeminiPart {
if (part.text !== undefined) return { text: part.text };
if (part.media) {
if (part.media.url.startsWith('data:')) return toInlineData(part);
return toFileData(part);
}
if (part.toolRequest) return toFunctionCall(part);
if (part.toolResponse) return toFunctionResponse(part);
if (part.custom) return toCustomPart(part);
throw new Error('Unsupported Part type');
}
function fromGeminiPart(part: GeminiPart, jsonMode: boolean): Part {
if (jsonMode && part.text !== undefined) {
return { data: extractJson(part.text) };
}
if (part.text !== undefined) return { text: part.text };
if (part.inlineData) return fromInlineData(part);
if (part.functionCall) return fromFunctionCall(part);
if (part.functionResponse) return fromFunctionResponse(part);
if (part.executableCode) return fromExecutableCode(part);
if (part.codeExecutionResult) return fromCodeExecutionResult(part);
throw new Error('Unsupported GeminiPart type');
}
export function toGeminiMessage(
message: MessageData,
model?: ModelReference<z.ZodTypeAny>
): GeminiMessage {
return {
role: toGeminiRole(message.role, model),
parts: message.content.map(toGeminiPart),
};
}
export function toGeminiSystemInstruction(message: MessageData): GeminiMessage {
return {
role: 'user',
parts: message.content.map(toGeminiPart),
};
}
function fromGeminiFinishReason(
reason: GeminiCandidate['finishReason']
): CandidateData['finishReason'] {
if (!reason) return 'unknown';
switch (reason) {
case 'STOP':
return 'stop';
case 'MAX_TOKENS':
return 'length';
case 'SAFETY': // blocked for safety
case 'RECITATION': // blocked for reciting training data
return 'blocked';
default:
return 'unknown';
}
}
export function fromGeminiCandidate(
candidate: GeminiCandidate,
jsonMode: boolean = false
): CandidateData {
return {
index: candidate.index || 0, // reasonable default?
message: {
role: 'model',
content: (candidate.content?.parts || []).map((part) =>
fromGeminiPart(part, jsonMode)
),
},
finishReason: fromGeminiFinishReason(candidate.finishReason),
finishMessage: candidate.finishMessage,
custom: {
safetyRatings: candidate.safetyRatings,
citationMetadata: candidate.citationMetadata,
},
};
}
/**
*
*/
export function googleAIModel(
name: string,
apiKey?: string,
apiVersion?: string,
baseUrl?: string
): ModelAction {
const modelName = `googleai/${name}`;
if (!apiKey) {
apiKey = process.env.GOOGLE_GENAI_API_KEY || process.env.GOOGLE_API_KEY;
}
if (!apiKey) {
throw new Error(
'Please pass in the API key or set the GOOGLE_GENAI_API_KEY or GOOGLE_API_KEY environment variable.\n' +
'For more details see https://firebase.google.com/docs/genkit/plugins/google-genai'
);
}
const model: ModelReference<z.ZodTypeAny> = SUPPORTED_MODELS[name];
if (!model) throw new Error(`Unsupported model: ${name}`);
const middleware: ModelMiddleware[] = [];
if (SUPPORTED_V1_MODELS[name]) {
middleware.push(simulateSystemPrompt());
}
if (model?.info?.supports?.media) {
// the gemini api doesn't support downloading media from http(s)
middleware.push(
downloadRequestMedia({
maxBytes: 1024 * 1024 * 10,
// don't downlaod files that have been uploaded using the Files API
filter: (part) =>
!part.media.url.startsWith(
'https://generativelanguage.googleapis.com/'
),
})
);
}
return defineModel(
{
name: modelName,
...model.info,
configSchema: model.configSchema,
use: middleware,
},
async (request, streamingCallback) => {
const options: RequestOptions = { apiClient: GENKIT_CLIENT_HEADER };
if (apiVersion) {
options.apiVersion = apiVersion;
}
if (apiVersion) {
options.baseUrl = baseUrl;
}
const client = new GoogleGenerativeAI(apiKey!).getGenerativeModel(
{
model: request.config?.version || model.version || name,
},
options
);
// make a copy so that modifying the request will not produce side-effects
const messages = [...request.messages];
if (messages.length === 0) throw new Error('No messages provided.');
// Gemini does not support messages with role system and instead expects
// systemInstructions to be provided as a separate input. The first
// message detected with role=system will be used for systemInstructions.
// Any additional system messages may be considered to be "exceptional".
let systemInstruction: GeminiMessage | undefined = undefined;
if (SUPPORTED_V15_MODELS[name]) {
const systemMessage = messages.find((m) => m.role === 'system');
if (systemMessage) {
messages.splice(messages.indexOf(systemMessage), 1);
systemInstruction = toGeminiSystemInstruction(systemMessage);
}
}
const tools: Tool[] = [];
if (request.tools?.length) {
tools.push({
functionDeclarations: request.tools.map(toGeminiTool),
});
}
if (request.config?.codeExecution) {
tools.push({
codeExecution:
request.config.codeExecution === true
? {}
: request.config.codeExecution,
});
}
// cannot use tools with json mode
const jsonMode =
(request.output?.format === 'json' || !!request.output?.schema) &&
tools.length === 0;
const generationConfig: GenerationConfig = {
candidateCount: request.candidates || undefined,
temperature: request.config?.temperature,
maxOutputTokens: request.config?.maxOutputTokens,
topK: request.config?.topK,
topP: request.config?.topP,
stopSequences: request.config?.stopSequences,
responseMimeType: jsonMode ? 'application/json' : undefined,
};
const chatRequest = {
systemInstruction,
generationConfig,
tools,
history: messages
.slice(0, -1)
.map((message) => toGeminiMessage(message, model)),
safetySettings: request.config?.safetySettings,
} as StartChatParams;
const msg = toGeminiMessage(messages[messages.length - 1], model);
const fromJSONModeScopedGeminiCandidate = (
candidate: GeminiCandidate
) => {
return fromGeminiCandidate(candidate, jsonMode);
};
if (streamingCallback) {
const result = await client
.startChat(chatRequest)
.sendMessageStream(msg.parts, options);
for await (const item of result.stream) {
(item as GenerateContentResponse).candidates?.forEach((candidate) => {
const c = fromJSONModeScopedGeminiCandidate(candidate);
streamingCallback({
index: c.index,
content: c.message.content,
});
});
}
const response = await result.response;
if (!response.candidates?.length) {
throw new Error('No valid candidates returned.');
}
return {
candidates:
response.candidates?.map(fromJSONModeScopedGeminiCandidate) || [],
custom: response,
};
} else {
const result = await client
.startChat(chatRequest)
.sendMessage(msg.parts, options);
if (!result.response.candidates?.length)
throw new Error('No valid candidates returned.');
const responseCandidates =
result.response.candidates?.map(fromJSONModeScopedGeminiCandidate) ||
[];
return {
candidates: responseCandidates,
custom: result.response,
usage: {
...getBasicUsageStats(request.messages, responseCandidates),
inputTokens: result.response.usageMetadata?.promptTokenCount,
outputTokens: result.response.usageMetadata?.candidatesTokenCount,
totalTokens: result.response.usageMetadata?.totalTokenCount,
},
};
}
}
);
}