Repository navigation
Expand file tree
/
Copy pathmodels.ts
More file actions
2048 lines (1919 loc) · 65.3 KB
/
Copy pathmodels.ts
File metadata and controls
2048 lines (1919 loc) · 65.3 KB
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
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
// Code generated by the Google Gen AI SDK generator DO NOT EDIT.
import * as afc from './_afc.js';
import {ApiClient} from './_api_client.js';
import * as common from './_common.js';
import {BaseModule} from './_common.js';
import * as _internal_types from './_internal_types.js';
import {
tContents,
tEmbedContents,
tIsMultimodalEmbeddingModel,
tIsVertexEmbedContentModel,
tIsVertexMaasModel,
} from './_transformers.js';
import * as converters from './converters/_models_converters.js';
import * as mcp from './mcp/_mcp.js';
import {PagedItem, Pager} from './pagers.js';
import * as types from './types.js';
export class Models extends BaseModule {
constructor(private readonly apiClient: ApiClient) {
super();
}
private static loggedGenerateImagesWarning = false;
private static loggedEditImageWarning = false;
private static loggedGenerateVideosWarning = false;
/**
* Calculates embeddings for the given contents.
*
* @param params - The parameters for embedding contents.
* @return The response from the API.
*
* @example
* ```ts
* const response = await ai.models.embedContent({
* model: 'text-embedding-004',
* contents: [
* 'What is your name?',
* 'What is your favorite color?',
* ],
* config: {
* outputDimensionality: 64,
* },
* });
* console.log(response);
* ```
*/
embedContent = async (
params: types.EmbedContentParameters,
): Promise<types.EmbedContentResponse> => {
if (!this.apiClient.isVertexAI()) {
const mldevContents = tIsMultimodalEmbeddingModel(params.model)
? tContents(params.contents)
: params.contents;
return await this.embedContentInternal({
model: params.model,
contents: mldevContents,
config: params.config,
});
}
if (tIsVertexEmbedContentModel(params.model)) {
const contents = tEmbedContents(params.model, params.contents);
if (contents.length > 1) {
if (tIsVertexMaasModel(params.model)) {
throw new Error(
'The embedContent API for this model only supports one content at a time.',
);
}
const paramsPrivate: types.EmbedContentParametersPrivate = {
model: params.model,
batchContents: contents,
embeddingApiType: types.EmbeddingApiType.BATCH_EMBED_CONTENTS,
config: params.config,
};
return await this.embedContentInternal(paramsPrivate);
}
const paramsPrivate: types.EmbedContentParametersPrivate = {
model: params.model,
content: contents[0],
embeddingApiType: types.EmbeddingApiType.EMBED_CONTENT,
config: params.config,
};
return await this.embedContentInternal(paramsPrivate);
} else {
const paramsPrivate: types.EmbedContentParametersPrivate = {
model: params.model,
contents: params.contents,
embeddingApiType: types.EmbeddingApiType.PREDICT,
config: params.config,
};
return await this.embedContentInternal(paramsPrivate);
}
};
private async generateContentWithContinuation(
params: types.GenerateContentParameters,
): Promise<types.GenerateContentResponse> {
const enableContinuation = afc.shouldEnableAutomaticContinuation(
params.config,
true,
);
let continuationToken: string | undefined = undefined;
const responses: types.GenerateContentResponse[] = [];
while (
responses.length === 0 ||
(enableContinuation && Boolean(continuationToken))
) {
const callConfig = afc.prepareContinuationConfig(
params.config,
continuationToken,
);
const callParams: types.GenerateContentParameters =
callConfig === params.config ? params : {...params, config: callConfig};
const response = await this.generateContentInternal(callParams);
responses.push(response);
continuationToken = afc.shouldContinueGeneration(response);
}
return afc.mergeContinuationResponses(responses);
}
private async generateContentStreamWithContinuation(
params: types.GenerateContentParameters,
): Promise<AsyncGenerator<types.GenerateContentResponse>> {
const state = new afc.StreamContinuation(params.config);
// The first hop has no continuationToken, so its config is params.config.
state.startHop();
const firstStream = await this.generateContentStreamInternal(params);
return (async function* (
models: Models,
initialParams: types.GenerateContentParameters,
initialStream: AsyncGenerator<types.GenerateContentResponse>,
) {
// The first hop was opened by the caller. Later hops are opened inside
// the try block, so a failure to open one is handled by endHop like a
// mid-stream error.
let openHop = async () => initialStream;
while (true) {
let hopError: {error: unknown} | undefined = undefined;
try {
for await (const chunk of await openHop()) {
yield state.observe(chunk);
}
} catch (error) {
hopError = {error};
}
// Resume from a new checkpoint, retry a dropped hop from its starting
// continuationToken if it yielded no content, or stop.
if (!state.endHop(hopError)) {
return;
}
const callParams: types.GenerateContentParameters = {
...initialParams,
config: state.startHop(),
};
openHop = () => models.generateContentStreamInternal(callParams);
}
})(this, params, firstStream);
}
/**
* Makes an API request to generate content with a given model.
*
* For the `model` parameter, supported formats for Gemini Enterprise Agent Platform API include:
* - The Gemini model ID, for example: 'gemini-3.8-flash'
* - The full resource name starts with 'projects/', for example:
* 'projects/my-project-id/locations/us-central1/publishers/google/models/gemini-3.8-flash'
* - The partial resource name with 'publishers/', for example:
* 'publishers/google/models/gemini-3.8-flash' or
* 'publishers/meta/models/llama-3.1-405b-instruct-maas'
* - `/` separated publisher and model name, for example:
* 'google/gemini-3.8-flash' or 'meta/llama-3.1-405b-instruct-maas'
*
* For the `model` parameter, supported formats for Gemini API include:
* - The Gemini model ID, for example: 'gemini-3.8-flash'
* - The model name starts with 'models/', for example:
* 'models/gemini-3.8-flash'
* - For tuned models, the model name starts with 'tunedModels/',
* for example:
* 'tunedModels/1234567890123456789'
*
* Some models support multimodal input and output. Automatic continuation
* (`config.automaticContinuation`) is enabled by default (`true`); set
* `config.automaticContinuation = false` to disable it.
*
* @param params - The parameters for generating content.
* @return The response from generating content.
*
* @example
* ```ts
* const response = await ai.models.generateContent({
* model: 'gemini-3.8-flash',
* contents: 'why is the sky blue?',
* config: {
* candidateCount: 2,
* }
* });
* console.log(response);
* ```
*/
generateContent = async (
params: types.GenerateContentParameters,
): Promise<types.GenerateContentResponse> => {
const transformedParams = await this.processParamsMaybeAddMcpUsage(params);
this.maybeMoveToResponseJsonSchema(params);
if (!afc.hasCallableTools(params) || afc.shouldDisableAfc(params.config)) {
const enableContinuation = afc.shouldEnableAutomaticContinuation(
params.config,
true,
);
if (!enableContinuation) {
return await this.generateContentInternal(transformedParams);
}
return await this.generateContentWithContinuation(transformedParams);
}
const incompatibleToolIndexes = afc.findAfcIncompatibleToolIndexes(params);
if (incompatibleToolIndexes.length > 0) {
const formattedIndexes = incompatibleToolIndexes
.map((index: number) => `tools[${index}]`)
.join(', ');
throw new Error(
`Automatic function calling with CallableTools (or MCP objects) and basic FunctionDeclarations is not yet supported. Incompatible tools found at ${
formattedIndexes
}.`,
);
}
let response: types.GenerateContentResponse;
let functionResponseContent: types.Content;
const automaticFunctionCallingHistory: types.Content[] = tContents(
transformedParams.contents,
);
const maxRemoteCalls =
transformedParams.config?.automaticFunctionCalling?.maximumRemoteCalls ??
afc.DEFAULT_MAX_REMOTE_CALLS;
let remoteCalls = 0;
while (remoteCalls < maxRemoteCalls) {
response = await this.generateContentWithContinuation(transformedParams);
if (!response.functionCalls || response.functionCalls!.length === 0) {
break;
}
const responseContent: types.Content = response.candidates![0].content!;
const functionResponseParts: types.Part[] = [];
for (const tool of params.config?.tools ?? []) {
if (afc.isCallableTool(tool)) {
const callableTool = tool as types.CallableTool;
const parts = await callableTool.callTool(response.functionCalls!);
functionResponseParts.push(...parts);
}
}
remoteCalls++;
functionResponseContent = {
role: 'user',
parts: functionResponseParts,
};
transformedParams.contents = tContents(transformedParams.contents);
(transformedParams.contents as types.Content[]).push(responseContent);
(transformedParams.contents as types.Content[]).push(
functionResponseContent,
);
if (afc.shouldAppendAfcHistory(transformedParams.config)) {
automaticFunctionCallingHistory.push(responseContent);
automaticFunctionCallingHistory.push(functionResponseContent);
}
}
if (afc.shouldAppendAfcHistory(transformedParams.config)) {
response!.automaticFunctionCallingHistory =
automaticFunctionCallingHistory;
}
return response!;
};
/**
* This logic is needed for GenerateContentConfig only.
* Previously we made GenerateContentConfig.responseSchema field to accept
* unknown. Since v1.9.0, we switch to use backend JSON schema support.
* To maintain backward compatibility, we move the data that was treated as
* JSON schema from the responseSchema field to the responseJsonSchema field.
*/
private maybeMoveToResponseJsonSchema(
params: types.GenerateContentParameters,
): void {
if (params.config && params.config.responseSchema) {
if (!params.config.responseJsonSchema) {
if (Object.keys(params.config.responseSchema).includes('$schema')) {
params.config.responseJsonSchema = params.config.responseSchema;
delete params.config.responseSchema;
}
}
}
return;
}
/**
* Makes an API request to generate content with a given model and yields the
* response in chunks.
*
* For the `model` parameter, supported formats for Gemini Enterprise Agent Platform API include:
* - The Gemini model ID, for example: 'gemini-3.8-flash'
* - The full resource name starts with 'projects/', for example:
* 'projects/my-project-id/locations/us-central1/publishers/google/models/gemini-3.8-flash'
* - The partial resource name with 'publishers/', for example:
* 'publishers/google/models/gemini-3.8-flash' or
* 'publishers/meta/models/llama-3.1-405b-instruct-maas'
* - `/` separated publisher and model name, for example:
* 'google/gemini-3.8-flash' or 'meta/llama-3.1-405b-instruct-maas'
*
* For the `model` parameter, supported formats for Gemini API include:
* - The Gemini model ID, for example: 'gemini-3.8-flash'
* - The model name starts with 'models/', for example:
* 'models/gemini-3.8-flash'
* - For tuned models, the model name starts with 'tunedModels/',
* for example:
* 'tunedModels/1234567890123456789'
*
* Some models support multimodal input and output. Automatic continuation
* (`config.automaticContinuation`) is enabled by default (`true`); set
* `config.automaticContinuation = false` to disable it.
*
* @param params - The parameters for generating content with streaming response.
* @return The response from generating content.
*
* @example
* ```ts
* const response = await ai.models.generateContentStream({
* model: 'gemini-3.8-flash',
* contents: 'why is the sky blue?',
* config: {
* maxOutputTokens: 200,
* }
* });
* for await (const chunk of response) {
* console.log(chunk);
* }
* ```
*/
generateContentStream = async (
params: types.GenerateContentParameters,
): Promise<AsyncGenerator<types.GenerateContentResponse>> => {
this.maybeMoveToResponseJsonSchema(params);
if (afc.shouldDisableAfc(params.config)) {
const transformedParams =
await this.processParamsMaybeAddMcpUsage(params);
const enableContinuation = afc.shouldEnableAutomaticContinuation(
params.config,
true,
);
if (!enableContinuation) {
return await this.generateContentStreamInternal(transformedParams);
}
return await this.generateContentStreamWithContinuation(
transformedParams,
);
}
const incompatibleToolIndexes = afc.findAfcIncompatibleToolIndexes(params);
if (incompatibleToolIndexes.length > 0) {
const formattedIndexes = incompatibleToolIndexes
.map((index: number) => `tools[${index}]`)
.join(', ');
throw new Error(
`Incompatible tools found at ${
formattedIndexes
}. Automatic function calling with CallableTools (or MCP objects) and basic FunctionDeclarations" is not yet supported.`,
);
}
// With tool compatibility confirmed, validate that the configuration are
// compatible with each other and raise an error if invalid.
const streamFunctionCall =
params?.config?.toolConfig?.functionCallingConfig
?.streamFunctionCallArguments;
const disableAfc = params?.config?.automaticFunctionCalling?.disable;
if (streamFunctionCall && !disableAfc) {
throw new Error(
"Running in streaming mode with 'streamFunctionCallArguments' enabled, " +
'this feature is not compatible with automatic function calling (AFC). ' +
"Please set 'config.automaticFunctionCalling.disable' to true to disable AFC " +
"or leave 'config.toolConfig.functionCallingConfig.streamFunctionCallArguments' " +
'to be undefined or set to false to disable streaming function call arguments feature.',
);
}
return await this.processAfcStream(params);
};
/**
* Transforms the CallableTools in the parameters to be simply Tools, it
* copies the params into a new object and replaces the tools, it does not
* modify the original params. Also sets the MCP usage header if there are
* MCP tools in the parameters.
*/
private async processParamsMaybeAddMcpUsage(
params: types.GenerateContentParameters,
): Promise<types.GenerateContentParameters> {
const tools = params.config?.tools;
if (!tools) {
return params;
}
const transformedTools = await Promise.all(
tools.map(async (tool) => {
if (afc.isCallableTool(tool)) {
const callableTool = tool as types.CallableTool;
return await callableTool.tool();
}
return tool;
}),
);
const newParams: types.GenerateContentParameters = {
model: params.model,
contents: params.contents,
config: {
...params.config,
tools: transformedTools,
},
};
newParams.config!.tools = transformedTools;
if (
params.config &&
params.config.tools &&
mcp.hasMcpToolUsage(params.config.tools)
) {
const headers = params.config.httpOptions?.headers ?? {};
let newHeaders = {...headers};
if (Object.keys(newHeaders).length === 0) {
newHeaders = this.apiClient.getDefaultHeaders();
}
mcp.setMcpUsageHeader(newHeaders);
newParams.config!.httpOptions = {
...params.config.httpOptions,
headers: newHeaders,
};
}
return newParams;
}
private async initAfcToolsMap(
params: types.GenerateContentParameters,
): Promise<Map<string, types.CallableTool>> {
const afcTools: Map<string, types.CallableTool> = new Map();
for (const tool of params.config?.tools ?? []) {
if (afc.isCallableTool(tool)) {
const callableTool = tool as types.CallableTool;
const toolDeclaration = await callableTool.tool();
for (const declaration of toolDeclaration.functionDeclarations ?? []) {
if (!declaration.name) {
throw new Error('Function declaration name is required.');
}
if (afcTools.has(declaration.name)) {
throw new Error(
`Duplicate tool declaration name: ${declaration.name}`,
);
}
afcTools.set(declaration.name, callableTool);
}
}
}
return afcTools;
}
private async processAfcStream(
params: types.GenerateContentParameters,
): Promise<AsyncGenerator<types.GenerateContentResponse>> {
const maxRemoteCalls =
params.config?.automaticFunctionCalling?.maximumRemoteCalls ??
afc.DEFAULT_MAX_REMOTE_CALLS;
let wereFunctionsCalled = false;
let remoteCallCount = 0;
const afcToolsMap = await this.initAfcToolsMap(params);
return (async function* (
models: Models,
afcTools: Map<string, types.CallableTool>,
params: types.GenerateContentParameters,
) {
while (remoteCallCount < maxRemoteCalls) {
if (wereFunctionsCalled) {
remoteCallCount++;
wereFunctionsCalled = false;
}
const transformedParams =
await models.processParamsMaybeAddMcpUsage(params);
const response =
await models.generateContentStreamWithContinuation(transformedParams);
const functionResponses: types.Part[] = [];
const responseContents: types.Content[] = [];
for await (const chunk of response) {
yield chunk;
if (chunk.candidates && chunk.candidates[0]?.content) {
responseContents.push(chunk.candidates[0].content);
for (const part of chunk.candidates[0].content.parts ?? []) {
if (remoteCallCount < maxRemoteCalls && part.functionCall) {
if (!part.functionCall.name) {
throw new Error(
'Function call name was not returned by the model.',
);
}
if (!afcTools.has(part.functionCall.name)) {
throw new Error(
`Automatic function calling was requested, but not all the tools the model used implement the CallableTool interface. Available tools: ${afcTools.keys()}, missing tool: ${
part.functionCall.name
}`,
);
} else {
const responseParts = await afcTools
.get(part.functionCall.name)!
.callTool([part.functionCall]);
functionResponses.push(...responseParts);
}
}
}
}
}
if (functionResponses.length > 0) {
wereFunctionsCalled = true;
const typedResponseChunk = new types.GenerateContentResponse();
typedResponseChunk.candidates = [
{
content: {
role: 'user',
parts: functionResponses,
},
},
];
yield typedResponseChunk;
const newContents: types.Content[] = [];
newContents.push(...responseContents);
newContents.push({
role: 'user',
parts: functionResponses,
});
const updatedContents = tContents(params.contents).concat(
newContents,
);
params.contents = updatedContents;
} else {
break;
}
}
})(this, afcToolsMap, params);
}
/**
* Generates an image based on a text description and configuration.
*
* @param params - The parameters for generating images.
* @return The response from the API.
*
* @example
* ```ts
* const response = await client.models.generateImages({
* model: 'imagen-4.0-generate-001',
* prompt: 'Robot holding a red skateboard',
* config: {
* numberOfImages: 1,
* includeRaiReason: true,
* },
* });
* console.log(response?.generatedImages?.[0]?.image?.imageBytes);
* ```
*/
generateImages = async (
params: types.GenerateImagesParameters,
): Promise<types.GenerateImagesResponse> => {
if (!Models.loggedGenerateImagesWarning) {
Models.loggedGenerateImagesWarning = true;
console.warn(
'The generateImages method is deprecated and will be removed in the next major release (not before Jan. 1 2027). Please use the generateContent method with image models instead. See https://aistudio.google.com/docs/deprecations#imagen-models and https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/capabilities/image-generation#generate-images',
);
}
return await this.generateImagesInternal(params).then((apiResponse) => {
let positivePromptSafetyAttributes;
const generatedImages = [];
if (apiResponse?.generatedImages) {
for (const generatedImage of apiResponse.generatedImages) {
if (
generatedImage &&
generatedImage?.safetyAttributes &&
generatedImage?.safetyAttributes?.contentType === 'Positive Prompt'
) {
positivePromptSafetyAttributes = generatedImage?.safetyAttributes;
} else {
generatedImages.push(generatedImage);
}
}
}
let response: types.GenerateImagesResponse;
if (positivePromptSafetyAttributes) {
response = {
generatedImages: generatedImages,
positivePromptSafetyAttributes: positivePromptSafetyAttributes,
sdkHttpResponse: apiResponse.sdkHttpResponse,
};
} else {
response = {
generatedImages: generatedImages,
sdkHttpResponse: apiResponse.sdkHttpResponse,
};
}
return response;
});
};
list = async (
params?: types.ListModelsParameters,
): Promise<Pager<types.Model>> => {
const defaultConfig: types.ListModelsConfig = {
queryBase: true,
};
const actualConfig: types.ListModelsConfig = {
...defaultConfig,
...params?.config,
};
const actualParams: types.ListModelsParameters = {
config: actualConfig,
};
if (this.apiClient.isVertexAI()) {
if (!actualParams.config!.queryBase) {
if (actualParams.config?.filter) {
throw new Error(
'Filtering tuned models list is only supported in Gemini Developer API mode, not in Gemini Enterprise Agent Platform mode.',
);
} else {
actualParams.config!.filter = 'labels.tune-type:*';
}
}
}
return new Pager<types.Model>(
PagedItem.PAGED_ITEM_MODELS,
(x: types.ListModelsParameters) => this.listInternal(x),
await this.listInternal(actualParams),
actualParams,
);
};
/**
* Edits an image based on a prompt, list of reference images, and configuration.
*
* @param params - The parameters for editing an image.
* @return The response from the API.
*
* @example
* ```ts
* const response = await client.models.editImage({
* model: 'imagen-3.0-capability-001',
* prompt: 'Generate an image containing a mug with the product logo [1] visible on the side of the mug.',
* referenceImages: [subjectReferenceImage]
* config: {
* numberOfImages: 1,
* includeRaiReason: true,
* },
* });
* console.log(response?.generatedImages?.[0]?.image?.imageBytes);
* ```
*/
editImage = async (
params: types.EditImageParameters,
): Promise<types.EditImageResponse> => {
if (!Models.loggedEditImageWarning) {
Models.loggedEditImageWarning = true;
console.warn(
'The editImage method is deprecated and will be removed in the next major release (not before Jan. 1 2027). Please use the generateContent method with image models instead. See https://aistudio.google.com/docs/deprecations#imagen-models and https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/capabilities/gemini-edit-images#edit-an-image',
);
}
const paramsInternal: _internal_types.EditImageParametersInternal = {
model: params.model,
prompt: params.prompt,
referenceImages: [],
config: params.config,
};
if (params.referenceImages) {
if (params.referenceImages) {
paramsInternal.referenceImages = params.referenceImages.map((img) =>
img.toReferenceImageAPI(),
);
}
}
return await this.editImageInternal(paramsInternal);
};
/**
* Upscales an image based on an image, upscale factor, and configuration.
* Only supported in Gemini Enterprise Agent Platform currently.
*
* @param params - The parameters for upscaling an image.
* @return The response from the API.
*
* @example
* ```ts
* const response = await client.models.upscaleImage({
* model: 'imagen-4.0-upscale-preview',
* image: image,
* upscaleFactor: 'x2',
* config: {
* includeRaiReason: true,
* },
* });
* console.log(response?.generatedImages?.[0]?.image?.imageBytes);
* ```
*/
upscaleImage = async (
params: types.UpscaleImageParameters,
): Promise<types.UpscaleImageResponse> => {
let apiConfig: _internal_types.UpscaleImageAPIConfigInternal = {
numberOfImages: 1,
mode: 'upscale',
};
if (params.config) {
apiConfig = {...apiConfig, ...params.config};
}
const apiParams: _internal_types.UpscaleImageAPIParametersInternal = {
model: params.model,
image: params.image,
upscaleFactor: params.upscaleFactor,
config: apiConfig,
};
return await this.upscaleImageInternal(apiParams);
};
/**
* Generates videos based on a text description and configuration.
*
* @param params - The parameters for generating videos.
* @return A Promise<GenerateVideosOperation> which allows you to track the progress and eventually retrieve the generated videos using the operations.get method.
*
* @example
* ```ts
* const operation = await ai.models.generateVideos({
* model: 'veo-2.0-generate-001',
* source: {
* prompt: 'A neon hologram of a cat driving at top speed',
* },
* config: {
* numberOfVideos: 1
* });
*
* while (!operation.done) {
* await new Promise(resolve => setTimeout(resolve, 10000));
* operation = await ai.operations.getVideosOperation({operation: operation});
* }
*
* console.log(operation.response?.generatedVideos?.[0]?.video?.uri);
* ```
*/
generateVideos = async (
params: types.GenerateVideosParameters,
): Promise<types.GenerateVideosOperation> => {
if ((params.prompt || params.image || params.video) && params.source) {
throw new Error(
'Source and prompt/image/video are mutually exclusive. Please only use source.',
);
}
if (params.prompt || params.image || params.video) {
if (!Models.loggedGenerateVideosWarning) {
Models.loggedGenerateVideosWarning = true;
console.warn(
'The generateVideos method with prompt/image/video arguments is deprecated and will be removed in a future major release (not before 2026-07-31). Please use the source argument instead.',
);
}
}
// Gemini API does not support video bytes.
if (!this.apiClient.isVertexAI()) {
if (params.video?.uri && params.video?.videoBytes) {
params.video = {
uri: params.video.uri,
mimeType: params.video.mimeType,
};
} else if (
params.source?.video?.uri &&
params.source?.video?.videoBytes
) {
params.source.video = {
uri: params.source.video.uri,
mimeType: params.source.video.mimeType,
};
}
}
return await this.generateVideosInternal(params);
};
private async generateContentInternal(
params: types.GenerateContentParameters,
): Promise<types.GenerateContentResponse> {
let response: Promise<types.GenerateContentResponse>;
let path: string = '';
let queryParams: Record<string, string> = {};
if (this.apiClient.isVertexAI()) {
const body = converters.generateContentParametersToVertex(
this.apiClient,
params,
params,
);
path = common.formatMap(
'{model}:generateContent',
body['_url'] as Record<string, unknown>,
);
queryParams = body['_query'] as Record<string, string>;
delete body['_url'];
delete body['_query'];
response = this.apiClient
.request({
path: path,
queryParams: queryParams,
body: JSON.stringify(body),
httpMethod: 'POST',
httpOptions: params.config?.httpOptions,
abortSignal: params.config?.abortSignal,
})
.then((httpResponse) => {
return httpResponse.json().then((jsonResponse) => {
const response = jsonResponse as types.GenerateContentResponse;
response.sdkHttpResponse = {
headers: httpResponse.headers,
} as types.HttpResponse;
return response;
});
}) as Promise<types.GenerateContentResponse>;
return response.then((apiResponse) => {
const resp = converters.generateContentResponseFromVertex(
apiResponse,
params,
);
const typedResp = new types.GenerateContentResponse();
Object.assign(typedResp, resp);
return typedResp;
});
} else {
const body = converters.generateContentParametersToMldev(
this.apiClient,
params,
params,
);
path = common.formatMap(
'{model}:generateContent',
body['_url'] as Record<string, unknown>,
);
queryParams = body['_query'] as Record<string, string>;
delete body['_url'];
delete body['_query'];
response = this.apiClient
.request({
path: path,
queryParams: queryParams,
body: JSON.stringify(body),
httpMethod: 'POST',
httpOptions: params.config?.httpOptions,
abortSignal: params.config?.abortSignal,
})
.then((httpResponse) => {
return httpResponse.json().then((jsonResponse) => {
const response = jsonResponse as types.GenerateContentResponse;
response.sdkHttpResponse = {
headers: httpResponse.headers,
} as types.HttpResponse;
return response;
});
}) as Promise<types.GenerateContentResponse>;
return response.then((apiResponse) => {
const resp = converters.generateContentResponseFromMldev(
apiResponse,
params,
);
const typedResp = new types.GenerateContentResponse();
Object.assign(typedResp, resp);
return typedResp;
});
}
}
private async generateContentStreamInternal(
params: types.GenerateContentParameters,
): Promise<AsyncGenerator<types.GenerateContentResponse>> {
let response: Promise<AsyncGenerator<types.HttpResponse>>;
let path: string = '';
let queryParams: Record<string, string> = {};
if (this.apiClient.isVertexAI()) {
const body = converters.generateContentParametersToVertex(
this.apiClient,
params,
params,
);
path = common.formatMap(
'{model}:streamGenerateContent?alt=sse',
body['_url'] as Record<string, unknown>,
);
queryParams = body['_query'] as Record<string, string>;
delete body['_url'];
delete body['_query'];
const apiClient = this.apiClient;
response = apiClient.requestStream({
path: path,
queryParams: queryParams,
body: JSON.stringify(body),
httpMethod: 'POST',
httpOptions: params.config?.httpOptions,
abortSignal: params.config?.abortSignal,
}) as Promise<AsyncGenerator<types.HttpResponse>>;
return response.then(async function* (
apiResponse: AsyncGenerator<types.HttpResponse>,
) {
for await (const chunk of apiResponse) {
const resp = converters.generateContentResponseFromVertex(
(await chunk.json()) as types.GenerateContentResponse,
params,
);
resp['sdkHttpResponse'] = {
headers: chunk.headers,
} as types.HttpResponse;
const typedResp = new types.GenerateContentResponse();
Object.assign(typedResp, resp);
yield typedResp;
}
});
} else {
const body = converters.generateContentParametersToMldev(
this.apiClient,
params,
params,
);
path = common.formatMap(
'{model}:streamGenerateContent?alt=sse',
body['_url'] as Record<string, unknown>,
);
queryParams = body['_query'] as Record<string, string>;
delete body['_url'];
delete body['_query'];
const apiClient = this.apiClient;
response = apiClient.requestStream({
path: path,
queryParams: queryParams,
body: JSON.stringify(body),
httpMethod: 'POST',
httpOptions: params.config?.httpOptions,
abortSignal: params.config?.abortSignal,
}) as Promise<AsyncGenerator<types.HttpResponse>>;
return response.then(async function* (
apiResponse: AsyncGenerator<types.HttpResponse>,
) {
for await (const chunk of apiResponse) {
const resp = converters.generateContentResponseFromMldev(
(await chunk.json()) as types.GenerateContentResponse,
params,
);
resp['sdkHttpResponse'] = {
headers: chunk.headers,
} as types.HttpResponse;
const typedResp = new types.GenerateContentResponse();
Object.assign(typedResp, resp);
yield typedResp;
}
});
}
}
/**
* Calculates embeddings for the given contents. Only text is supported.
*