@google/genai 1.37.0 → 1.39.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/genai.d.ts +195 -50
- package/dist/index.cjs +443 -169
- package/dist/index.mjs +443 -170
- package/dist/index.mjs.map +1 -1
- package/dist/node/index.cjs +489 -170
- package/dist/node/index.mjs +489 -171
- package/dist/node/index.mjs.map +1 -1
- package/dist/node/node.d.ts +195 -50
- package/dist/tokenizer/node.cjs +16 -0
- package/dist/tokenizer/node.d.ts +14 -0
- package/dist/tokenizer/node.mjs +16 -0
- package/dist/tokenizer/node.mjs.map +1 -1
- package/dist/web/index.mjs +443 -170
- package/dist/web/index.mjs.map +1 -1
- package/dist/web/web.d.ts +195 -50
- package/package.json +1 -1
package/dist/web/web.d.ts
CHANGED
|
@@ -121,25 +121,12 @@ export declare interface ApiAuthApiKeyConfig {
|
|
|
121
121
|
*/
|
|
122
122
|
declare class ApiClient implements GeminiNextGenAPIClientAdapter {
|
|
123
123
|
readonly clientOptions: ApiClientInitOptions;
|
|
124
|
+
private readonly customBaseUrl?;
|
|
124
125
|
constructor(opts: ApiClientInitOptions);
|
|
125
|
-
/**
|
|
126
|
-
* Determines the base URL for Vertex AI based on project and location.
|
|
127
|
-
* Uses the global endpoint if location is 'global' or if project/location
|
|
128
|
-
* are not specified (implying API key usage).
|
|
129
|
-
* @private
|
|
130
|
-
*/
|
|
131
|
-
private baseUrlFromProjectLocation;
|
|
132
|
-
/**
|
|
133
|
-
* Normalizes authentication parameters for Vertex AI.
|
|
134
|
-
* If project and location are provided, API key is cleared.
|
|
135
|
-
* If project and location are not provided (implying API key usage),
|
|
136
|
-
* project and location are cleared.
|
|
137
|
-
* @private
|
|
138
|
-
*/
|
|
139
|
-
private normalizeAuthParameters;
|
|
140
126
|
isVertexAI(): boolean;
|
|
141
127
|
getProject(): string | undefined;
|
|
142
128
|
getLocation(): string | undefined;
|
|
129
|
+
getCustomBaseUrl(): string | undefined;
|
|
143
130
|
getAuthHeaders(): Promise<Headers>;
|
|
144
131
|
getApiVersion(): string;
|
|
145
132
|
getBaseUrl(): string;
|
|
@@ -580,6 +567,10 @@ declare class BadRequestError extends APIError<400, Headers> {
|
|
|
580
567
|
}
|
|
581
568
|
|
|
582
569
|
declare interface BaseCreateAgentInteractionParams {
|
|
570
|
+
/**
|
|
571
|
+
* Path param: Which version of the API to use.
|
|
572
|
+
*/
|
|
573
|
+
api_version?: string;
|
|
583
574
|
/**
|
|
584
575
|
* Body param: The name of the `Agent` used for generating the interaction.
|
|
585
576
|
*/
|
|
@@ -588,16 +579,12 @@ declare interface BaseCreateAgentInteractionParams {
|
|
|
588
579
|
* Body param: The inputs for the interaction.
|
|
589
580
|
*/
|
|
590
581
|
input: string | Array<Content_2> | Array<Turn> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent | ThoughtContent | FunctionCallContent | FunctionResultContent | CodeExecutionCallContent | CodeExecutionResultContent | URLContextCallContent | URLContextResultContent | GoogleSearchCallContent | GoogleSearchResultContent | MCPServerToolCallContent | MCPServerToolResultContent | FileSearchCallContent | FileSearchResultContent;
|
|
591
|
-
/**
|
|
592
|
-
* Path param: Which version of the API to use.
|
|
593
|
-
*/
|
|
594
|
-
api_version?: string;
|
|
595
582
|
/**
|
|
596
583
|
* Body param: Configuration for the agent.
|
|
597
584
|
*/
|
|
598
585
|
agent_config?: DynamicAgentConfig | DeepResearchAgentConfig;
|
|
599
586
|
/**
|
|
600
|
-
* Body param: Whether to run the model interaction in the background.
|
|
587
|
+
* Body param: Input only. Whether to run the model interaction in the background.
|
|
601
588
|
*/
|
|
602
589
|
background?: boolean;
|
|
603
590
|
/**
|
|
@@ -636,6 +623,10 @@ declare interface BaseCreateAgentInteractionParams {
|
|
|
636
623
|
}
|
|
637
624
|
|
|
638
625
|
declare interface BaseCreateModelInteractionParams {
|
|
626
|
+
/**
|
|
627
|
+
* Path param: Which version of the API to use.
|
|
628
|
+
*/
|
|
629
|
+
api_version?: string;
|
|
639
630
|
/**
|
|
640
631
|
* Body param: The inputs for the interaction.
|
|
641
632
|
*/
|
|
@@ -645,11 +636,7 @@ declare interface BaseCreateModelInteractionParams {
|
|
|
645
636
|
*/
|
|
646
637
|
model: Model_2;
|
|
647
638
|
/**
|
|
648
|
-
*
|
|
649
|
-
*/
|
|
650
|
-
api_version?: string;
|
|
651
|
-
/**
|
|
652
|
-
* Body param: Whether to run the model interaction in the background.
|
|
639
|
+
* Body param: Input only. Whether to run the model interaction in the background.
|
|
653
640
|
*/
|
|
654
641
|
background?: boolean;
|
|
655
642
|
/**
|
|
@@ -788,6 +775,7 @@ declare class BaseInteractions extends APIResource {
|
|
|
788
775
|
* @example
|
|
789
776
|
* ```ts
|
|
790
777
|
* const interaction = await client.interactions.create({
|
|
778
|
+
* api_version: 'api_version',
|
|
791
779
|
* input: 'string',
|
|
792
780
|
* model: 'gemini-2.5-pro',
|
|
793
781
|
* });
|
|
@@ -803,7 +791,9 @@ declare class BaseInteractions extends APIResource {
|
|
|
803
791
|
*
|
|
804
792
|
* @example
|
|
805
793
|
* ```ts
|
|
806
|
-
* const interaction = await client.interactions.delete('id'
|
|
794
|
+
* const interaction = await client.interactions.delete('id', {
|
|
795
|
+
* api_version: 'api_version',
|
|
796
|
+
* });
|
|
807
797
|
* ```
|
|
808
798
|
*/
|
|
809
799
|
delete(id: string, params?: InteractionDeleteParams | null | undefined, options?: RequestOptions): APIPromise<unknown>;
|
|
@@ -812,7 +802,9 @@ declare class BaseInteractions extends APIResource {
|
|
|
812
802
|
*
|
|
813
803
|
* @example
|
|
814
804
|
* ```ts
|
|
815
|
-
* const interaction = await client.interactions.cancel('id'
|
|
805
|
+
* const interaction = await client.interactions.cancel('id', {
|
|
806
|
+
* api_version: 'api_version',
|
|
807
|
+
* });
|
|
816
808
|
* ```
|
|
817
809
|
*/
|
|
818
810
|
cancel(id: string, params?: InteractionCancelParams | null | undefined, options?: RequestOptions): APIPromise<Interaction>;
|
|
@@ -821,7 +813,9 @@ declare class BaseInteractions extends APIResource {
|
|
|
821
813
|
*
|
|
822
814
|
* @example
|
|
823
815
|
* ```ts
|
|
824
|
-
* const interaction = await client.interactions.get('id'
|
|
816
|
+
* const interaction = await client.interactions.get('id', {
|
|
817
|
+
* api_version: 'api_version',
|
|
818
|
+
* });
|
|
825
819
|
* ```
|
|
826
820
|
*/
|
|
827
821
|
get(id: string, params?: InteractionGetParamsNonStreaming, options?: RequestOptions): APIPromise<Interaction>;
|
|
@@ -1837,7 +1831,7 @@ declare namespace ContentDelta {
|
|
|
1837
1831
|
}
|
|
1838
1832
|
namespace FunctionResultDelta {
|
|
1839
1833
|
interface Items {
|
|
1840
|
-
items?: Array<
|
|
1834
|
+
items?: Array<InteractionsAPI.TextContent | InteractionsAPI.ImageContent | unknown>;
|
|
1841
1835
|
}
|
|
1842
1836
|
}
|
|
1843
1837
|
interface CodeExecutionCallDelta {
|
|
@@ -2452,7 +2446,7 @@ export declare interface CreateTuningJobConfig {
|
|
|
2452
2446
|
be charged usage for any applicable operations.
|
|
2453
2447
|
*/
|
|
2454
2448
|
abortSignal?: AbortSignal;
|
|
2455
|
-
/** The method to use for tuning (SUPERVISED_FINE_TUNING or PREFERENCE_TUNING). If not set, the default method (SFT) will be used. */
|
|
2449
|
+
/** The method to use for tuning (SUPERVISED_FINE_TUNING or PREFERENCE_TUNING or DISTILLATION). If not set, the default method (SFT) will be used. */
|
|
2456
2450
|
method?: TuningMethod;
|
|
2457
2451
|
/** Validation dataset for tuning. The dataset must be formatted as a JSONL file. */
|
|
2458
2452
|
validationDataset?: TuningValidationDataset;
|
|
@@ -2462,7 +2456,7 @@ export declare interface CreateTuningJobConfig {
|
|
|
2462
2456
|
description?: string;
|
|
2463
2457
|
/** Number of complete passes the model makes over the entire training dataset during training. */
|
|
2464
2458
|
epochCount?: number;
|
|
2465
|
-
/** Multiplier for adjusting the default learning rate. */
|
|
2459
|
+
/** Multiplier for adjusting the default learning rate. 1P models only. Mutually exclusive with learning_rate. */
|
|
2466
2460
|
learningRateMultiplier?: number;
|
|
2467
2461
|
/** If set to true, disable intermediate checkpoints and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints. */
|
|
2468
2462
|
exportLastCheckpointOnly?: boolean;
|
|
@@ -2470,14 +2464,26 @@ export declare interface CreateTuningJobConfig {
|
|
|
2470
2464
|
preTunedModelCheckpointId?: string;
|
|
2471
2465
|
/** Adapter size for tuning. */
|
|
2472
2466
|
adapterSize?: AdapterSize;
|
|
2473
|
-
/**
|
|
2467
|
+
/** Tuning mode for SFT tuning. */
|
|
2468
|
+
tuningMode?: TuningMode;
|
|
2469
|
+
/** Custom base model for tuning. This is only supported for OSS models in Vertex. */
|
|
2470
|
+
customBaseModel?: string;
|
|
2471
|
+
/** The batch size hyperparameter for tuning. This is only supported for OSS models in Vertex. */
|
|
2474
2472
|
batchSize?: number;
|
|
2475
|
-
/** The learning rate
|
|
2473
|
+
/** The learning rate for tuning. OSS models only. Mutually exclusive with learning_rate_multiplier. */
|
|
2476
2474
|
learningRate?: number;
|
|
2477
2475
|
/** Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. */
|
|
2478
2476
|
labels?: Record<string, string>;
|
|
2479
2477
|
/** Weight for KL Divergence regularization, Preference Optimization tuning only. */
|
|
2480
2478
|
beta?: number;
|
|
2479
|
+
/** The base teacher model that is being distilled. Distillation only. */
|
|
2480
|
+
baseTeacherModel?: string;
|
|
2481
|
+
/** The resource name of the Tuned teacher model. Distillation only. */
|
|
2482
|
+
tunedTeacherModelSource?: string;
|
|
2483
|
+
/** Multiplier for adjusting the weight of the SFT loss. Distillation only. */
|
|
2484
|
+
sftLossWeightMultiplier?: number;
|
|
2485
|
+
/** The Google Cloud Storage location where the tuning job outputs are written. */
|
|
2486
|
+
outputUri?: string;
|
|
2481
2487
|
}
|
|
2482
2488
|
|
|
2483
2489
|
/** Fine-tuning job creation parameters - optional fields. */
|
|
@@ -2752,6 +2758,36 @@ export declare interface DistillationDataStats {
|
|
|
2752
2758
|
trainingDatasetStats?: DatasetStats;
|
|
2753
2759
|
}
|
|
2754
2760
|
|
|
2761
|
+
/** Hyperparameters for Distillation. This data type is not supported in Gemini API. */
|
|
2762
|
+
export declare interface DistillationHyperParameters {
|
|
2763
|
+
/** Optional. Adapter size for distillation. */
|
|
2764
|
+
adapterSize?: AdapterSize;
|
|
2765
|
+
/** Optional. Number of complete passes the model makes over the entire training dataset during training. */
|
|
2766
|
+
epochCount?: string;
|
|
2767
|
+
/** Optional. Multiplier for adjusting the default learning rate. */
|
|
2768
|
+
learningRateMultiplier?: number;
|
|
2769
|
+
}
|
|
2770
|
+
|
|
2771
|
+
/** Distillation tuning spec for tuning. */
|
|
2772
|
+
export declare interface DistillationSpec {
|
|
2773
|
+
/** The GCS URI of the prompt dataset to use during distillation. */
|
|
2774
|
+
promptDatasetUri?: string;
|
|
2775
|
+
/** The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). */
|
|
2776
|
+
baseTeacherModel?: string;
|
|
2777
|
+
/** Optional. Hyperparameters for Distillation. */
|
|
2778
|
+
hyperParameters?: DistillationHyperParameters;
|
|
2779
|
+
/** Deprecated. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts. */
|
|
2780
|
+
pipelineRootDirectory?: string;
|
|
2781
|
+
/** The student model that is being tuned, e.g., "google/gemma-2b-1.1-it". Deprecated. Use base_model instead. */
|
|
2782
|
+
studentModel?: string;
|
|
2783
|
+
/** Deprecated. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */
|
|
2784
|
+
trainingDatasetUri?: string;
|
|
2785
|
+
/** The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. */
|
|
2786
|
+
tunedTeacherModelSource?: string;
|
|
2787
|
+
/** Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. */
|
|
2788
|
+
validationDatasetUri?: string;
|
|
2789
|
+
}
|
|
2790
|
+
|
|
2755
2791
|
/** A Document is a collection of Chunks. */
|
|
2756
2792
|
declare interface Document_2 {
|
|
2757
2793
|
/** The resource name of the Document.
|
|
@@ -3385,6 +3421,12 @@ export declare class Files extends BaseModule {
|
|
|
3385
3421
|
* ```
|
|
3386
3422
|
*/
|
|
3387
3423
|
download(params: types.DownloadFileParameters): Promise<void>;
|
|
3424
|
+
/**
|
|
3425
|
+
* Registers Google Cloud Storage files for use with the API.
|
|
3426
|
+
* This method is only available in Node.js environments.
|
|
3427
|
+
*/
|
|
3428
|
+
registerFiles(params: types.RegisterFilesParameters): Promise<types.RegisterFilesResponse>;
|
|
3429
|
+
protected _registerFiles(params: types.InternalRegisterFilesParameters): Promise<types.RegisterFilesResponse>;
|
|
3388
3430
|
private listInternal;
|
|
3389
3431
|
private createInternal;
|
|
3390
3432
|
/**
|
|
@@ -3417,6 +3459,7 @@ export declare class Files extends BaseModule {
|
|
|
3417
3459
|
* ```
|
|
3418
3460
|
*/
|
|
3419
3461
|
delete(params: types.DeleteFileParameters): Promise<types.DeleteFileResponse>;
|
|
3462
|
+
private registerFilesInternal;
|
|
3420
3463
|
}
|
|
3421
3464
|
|
|
3422
3465
|
/** Tool to retrieve knowledge from the File Search Stores. */
|
|
@@ -3919,7 +3962,7 @@ declare interface FunctionResultContent {
|
|
|
3919
3962
|
|
|
3920
3963
|
declare namespace FunctionResultContent {
|
|
3921
3964
|
interface Items {
|
|
3922
|
-
items?: Array<
|
|
3965
|
+
items?: Array<InteractionsAPI.TextContent | InteractionsAPI.ImageContent | unknown>;
|
|
3923
3966
|
}
|
|
3924
3967
|
}
|
|
3925
3968
|
|
|
@@ -4115,6 +4158,10 @@ export declare interface GenerateContentConfig {
|
|
|
4115
4158
|
models. This field is not supported in Vertex AI.
|
|
4116
4159
|
*/
|
|
4117
4160
|
enableEnhancedCivicAnswers?: boolean;
|
|
4161
|
+
/** Settings for prompt and response sanitization using the Model Armor
|
|
4162
|
+
service. If supplied, safety_settings must not be supplied.
|
|
4163
|
+
*/
|
|
4164
|
+
modelArmorConfig?: ModelArmorConfig;
|
|
4118
4165
|
}
|
|
4119
4166
|
|
|
4120
4167
|
/** Config for models.generate_content parameters. */
|
|
@@ -5374,6 +5421,8 @@ declare type HTTPMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
|
|
|
5374
5421
|
export declare interface HttpOptions {
|
|
5375
5422
|
/** The base URL for the AI platform service endpoint. */
|
|
5376
5423
|
baseUrl?: string;
|
|
5424
|
+
/** The resource scope used to constructing the resource name when base_url is set */
|
|
5425
|
+
baseUrlResourceScope?: ResourceScope;
|
|
5377
5426
|
/** Specifies the version of the API to use. */
|
|
5378
5427
|
apiVersion?: string;
|
|
5379
5428
|
/** Additional HTTP headers to be sent with the request. */
|
|
@@ -5642,6 +5691,8 @@ export declare class InlinedResponse {
|
|
|
5642
5691
|
/** The response to the request.
|
|
5643
5692
|
*/
|
|
5644
5693
|
response?: GenerateContentResponse;
|
|
5694
|
+
/** The metadata to be associated with the request. */
|
|
5695
|
+
metadata?: Record<string, string>;
|
|
5645
5696
|
/** The error encountered while processing the request.
|
|
5646
5697
|
*/
|
|
5647
5698
|
error?: JobError;
|
|
@@ -5702,6 +5753,18 @@ declare interface InteractionCancelParams {
|
|
|
5702
5753
|
api_version?: string;
|
|
5703
5754
|
}
|
|
5704
5755
|
|
|
5756
|
+
declare interface InteractionCompleteEvent {
|
|
5757
|
+
/**
|
|
5758
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
5759
|
+
*/
|
|
5760
|
+
event_id?: string;
|
|
5761
|
+
event_type?: 'interaction.complete';
|
|
5762
|
+
/**
|
|
5763
|
+
* The Interaction resource.
|
|
5764
|
+
*/
|
|
5765
|
+
interaction?: Interaction;
|
|
5766
|
+
}
|
|
5767
|
+
|
|
5705
5768
|
declare type InteractionCreateParams = CreateModelInteractionParamsNonStreaming | CreateModelInteractionParamsStreaming | CreateAgentInteractionParamsNonStreaming | CreateAgentInteractionParamsStreaming;
|
|
5706
5769
|
|
|
5707
5770
|
declare interface InteractionDeleteParams {
|
|
@@ -5713,18 +5776,6 @@ declare interface InteractionDeleteParams {
|
|
|
5713
5776
|
|
|
5714
5777
|
declare type InteractionDeleteResponse = unknown;
|
|
5715
5778
|
|
|
5716
|
-
declare interface InteractionEvent {
|
|
5717
|
-
/**
|
|
5718
|
-
* The event_id token to be used to resume the interaction stream, from this event.
|
|
5719
|
-
*/
|
|
5720
|
-
event_id?: string;
|
|
5721
|
-
event_type?: 'interaction.start' | 'interaction.complete';
|
|
5722
|
-
/**
|
|
5723
|
-
* The Interaction resource.
|
|
5724
|
-
*/
|
|
5725
|
-
interaction?: Interaction;
|
|
5726
|
-
}
|
|
5727
|
-
|
|
5728
5779
|
declare type InteractionGetParams = InteractionGetParamsNonStreaming | InteractionGetParamsStreaming;
|
|
5729
5780
|
|
|
5730
5781
|
declare namespace InteractionGetParams {
|
|
@@ -5737,6 +5788,10 @@ declare interface InteractionGetParamsBase {
|
|
|
5737
5788
|
* Path param: Which version of the API to use.
|
|
5738
5789
|
*/
|
|
5739
5790
|
api_version?: string;
|
|
5791
|
+
/**
|
|
5792
|
+
* Query param: If set to true, includes the input in the response.
|
|
5793
|
+
*/
|
|
5794
|
+
include_input?: boolean;
|
|
5740
5795
|
/**
|
|
5741
5796
|
* Query param: Optional. If set, resumes the interaction stream from the next chunk after the event marked by the event id. Can only be used if `stream` is true.
|
|
5742
5797
|
*/
|
|
@@ -5765,7 +5820,7 @@ export declare class Interactions extends BaseInteractions {
|
|
|
5765
5820
|
}
|
|
5766
5821
|
|
|
5767
5822
|
export declare namespace Interactions {
|
|
5768
|
-
export { type AllowedTools as AllowedTools, type Annotation as Annotation, type AudioContent as AudioContent, type AudioMimeType as AudioMimeType, type CodeExecutionCallArguments as CodeExecutionCallArguments, type CodeExecutionCallContent as CodeExecutionCallContent, type CodeExecutionResultContent as CodeExecutionResultContent, type Content_2 as Content, type ContentDelta as ContentDelta, type ContentStart as ContentStart, type ContentStop as ContentStop, type DeepResearchAgentConfig as DeepResearchAgentConfig, type DocumentContent as DocumentContent, type DocumentMimeType as DocumentMimeType, type DynamicAgentConfig as DynamicAgentConfig, type ErrorEvent_2 as ErrorEvent, type FileSearchCallContent as FileSearchCallContent, type FileSearchResultContent as FileSearchResultContent, type Function_2 as Function, type FunctionCallContent as FunctionCallContent, type FunctionResultContent as FunctionResultContent, type GenerationConfig_2 as GenerationConfig, type GoogleSearchCallArguments as GoogleSearchCallArguments, type GoogleSearchCallContent as GoogleSearchCallContent, type GoogleSearchResult as GoogleSearchResult, type GoogleSearchResultContent as GoogleSearchResultContent, type ImageConfig_2 as ImageConfig, type ImageContent as ImageContent, type ImageMimeType as ImageMimeType, type Interaction as Interaction, type
|
|
5823
|
+
export { type AllowedTools as AllowedTools, type Annotation as Annotation, type AudioContent as AudioContent, type AudioMimeType as AudioMimeType, type CodeExecutionCallArguments as CodeExecutionCallArguments, type CodeExecutionCallContent as CodeExecutionCallContent, type CodeExecutionResultContent as CodeExecutionResultContent, type Content_2 as Content, type ContentDelta as ContentDelta, type ContentStart as ContentStart, type ContentStop as ContentStop, type DeepResearchAgentConfig as DeepResearchAgentConfig, type DocumentContent as DocumentContent, type DocumentMimeType as DocumentMimeType, type DynamicAgentConfig as DynamicAgentConfig, type ErrorEvent_2 as ErrorEvent, type FileSearchCallContent as FileSearchCallContent, type FileSearchResultContent as FileSearchResultContent, type Function_2 as Function, type FunctionCallContent as FunctionCallContent, type FunctionResultContent as FunctionResultContent, type GenerationConfig_2 as GenerationConfig, type GoogleSearchCallArguments as GoogleSearchCallArguments, type GoogleSearchCallContent as GoogleSearchCallContent, type GoogleSearchResult as GoogleSearchResult, type GoogleSearchResultContent as GoogleSearchResultContent, type ImageConfig_2 as ImageConfig, type ImageContent as ImageContent, type ImageMimeType as ImageMimeType, type Interaction as Interaction, type InteractionCompleteEvent as InteractionCompleteEvent, type InteractionSSEEvent as InteractionSSEEvent, type InteractionStartEvent as InteractionStartEvent, type InteractionStatusUpdate as InteractionStatusUpdate, type MCPServerToolCallContent as MCPServerToolCallContent, type MCPServerToolResultContent as MCPServerToolResultContent, type Model_2 as Model, type SpeechConfig_2 as SpeechConfig, type TextContent as TextContent, type ThinkingLevel_2 as ThinkingLevel, type ThoughtContent as ThoughtContent, type Tool_2 as Tool, type ToolChoice as ToolChoice, type ToolChoiceConfig as ToolChoiceConfig, type ToolChoiceType as ToolChoiceType, type Turn as Turn, type URLContextCallArguments as URLContextCallArguments, type URLContextCallContent as URLContextCallContent, type URLContextResult as URLContextResult, type URLContextResultContent as URLContextResultContent, type Usage as Usage, type VideoContent as VideoContent, type VideoMimeType as VideoMimeType, type InteractionDeleteResponse as InteractionDeleteResponse, type InteractionCreateParams as InteractionCreateParams, type CreateModelInteractionParamsNonStreaming as CreateModelInteractionParamsNonStreaming, type CreateModelInteractionParamsStreaming as CreateModelInteractionParamsStreaming, type CreateAgentInteractionParamsNonStreaming as CreateAgentInteractionParamsNonStreaming, type CreateAgentInteractionParamsStreaming as CreateAgentInteractionParamsStreaming, type InteractionDeleteParams as InteractionDeleteParams, type InteractionCancelParams as InteractionCancelParams, type InteractionGetParams as InteractionGetParams, type InteractionGetParamsNonStreaming as InteractionGetParamsNonStreaming, type InteractionGetParamsStreaming as InteractionGetParamsStreaming, };
|
|
5769
5824
|
}
|
|
5770
5825
|
|
|
5771
5826
|
declare namespace InteractionsAPI {
|
|
@@ -5802,8 +5857,9 @@ declare namespace InteractionsAPI {
|
|
|
5802
5857
|
ImageContent,
|
|
5803
5858
|
ImageMimeType,
|
|
5804
5859
|
Interaction,
|
|
5805
|
-
|
|
5860
|
+
InteractionCompleteEvent,
|
|
5806
5861
|
InteractionSSEEvent,
|
|
5862
|
+
InteractionStartEvent,
|
|
5807
5863
|
InteractionStatusUpdate,
|
|
5808
5864
|
MCPServerToolCallContent,
|
|
5809
5865
|
MCPServerToolResultContent,
|
|
@@ -5841,7 +5897,19 @@ declare namespace InteractionsAPI {
|
|
|
5841
5897
|
}
|
|
5842
5898
|
}
|
|
5843
5899
|
|
|
5844
|
-
declare type InteractionSSEEvent =
|
|
5900
|
+
declare type InteractionSSEEvent = InteractionStartEvent | InteractionCompleteEvent | InteractionStatusUpdate | ContentStart | ContentDelta | ContentStop | ErrorEvent_2;
|
|
5901
|
+
|
|
5902
|
+
declare interface InteractionStartEvent {
|
|
5903
|
+
/**
|
|
5904
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
5905
|
+
*/
|
|
5906
|
+
event_id?: string;
|
|
5907
|
+
event_type?: 'interaction.start';
|
|
5908
|
+
/**
|
|
5909
|
+
* The Interaction resource.
|
|
5910
|
+
*/
|
|
5911
|
+
interaction?: Interaction;
|
|
5912
|
+
}
|
|
5845
5913
|
|
|
5846
5914
|
declare interface InteractionStatusUpdate {
|
|
5847
5915
|
/**
|
|
@@ -5853,6 +5921,14 @@ declare interface InteractionStatusUpdate {
|
|
|
5853
5921
|
status?: 'in_progress' | 'requires_action' | 'completed' | 'failed' | 'cancelled';
|
|
5854
5922
|
}
|
|
5855
5923
|
|
|
5924
|
+
/** Parameters for the private _Register method. */
|
|
5925
|
+
export declare interface InternalRegisterFilesParameters {
|
|
5926
|
+
/** The Google Cloud Storage URIs to register. Example: `gs://bucket/object`. */
|
|
5927
|
+
uris: string[];
|
|
5928
|
+
/** Used to override the default configuration. */
|
|
5929
|
+
config?: RegisterFilesConfig;
|
|
5930
|
+
}
|
|
5931
|
+
|
|
5856
5932
|
declare class InternalServerError extends APIError<number, Headers> {
|
|
5857
5933
|
}
|
|
5858
5934
|
|
|
@@ -7222,6 +7298,14 @@ export declare interface Model {
|
|
|
7222
7298
|
*/
|
|
7223
7299
|
declare type Model_2 = 'gemini-2.5-pro' | 'gemini-2.5-flash' | 'gemini-2.5-flash-preview-09-2025' | 'gemini-2.5-flash-lite' | 'gemini-2.5-flash-lite-preview-09-2025' | 'gemini-2.5-flash-preview-native-audio-dialog' | 'gemini-2.5-flash-image-preview' | 'gemini-2.5-pro-preview-tts' | 'gemini-3-pro-preview' | 'gemini-3-flash-preview' | (string & {});
|
|
7224
7300
|
|
|
7301
|
+
/** Configuration for Model Armor integrations of prompt and responses. This data type is not supported in Gemini API. */
|
|
7302
|
+
export declare interface ModelArmorConfig {
|
|
7303
|
+
/** Optional. The name of the Model Armor template to use for prompt sanitization. */
|
|
7304
|
+
promptTemplateName?: string;
|
|
7305
|
+
/** Optional. The name of the Model Armor template to use for response sanitization. */
|
|
7306
|
+
responseTemplateName?: string;
|
|
7307
|
+
}
|
|
7308
|
+
|
|
7225
7309
|
export declare class Models extends BaseModule {
|
|
7226
7310
|
private readonly apiClient;
|
|
7227
7311
|
constructor(apiClient: ApiClient);
|
|
@@ -8303,6 +8387,41 @@ declare interface ReferenceImageAPIInternal {
|
|
|
8303
8387
|
subjectImageConfig?: types.SubjectReferenceConfig;
|
|
8304
8388
|
}
|
|
8305
8389
|
|
|
8390
|
+
/** Used to override the default configuration. */
|
|
8391
|
+
export declare interface RegisterFilesConfig {
|
|
8392
|
+
/** Used to override HTTP request options. */
|
|
8393
|
+
httpOptions?: HttpOptions;
|
|
8394
|
+
/** Abort signal which can be used to cancel the request.
|
|
8395
|
+
|
|
8396
|
+
NOTE: AbortSignal is a client-only operation. Using it to cancel an
|
|
8397
|
+
operation will not cancel the request in the service. You will still
|
|
8398
|
+
be charged usage for any applicable operations.
|
|
8399
|
+
*/
|
|
8400
|
+
abortSignal?: AbortSignal;
|
|
8401
|
+
}
|
|
8402
|
+
|
|
8403
|
+
/** Generates the parameters for the private registerFiles method. */
|
|
8404
|
+
export declare interface RegisterFilesParameters {
|
|
8405
|
+
/**
|
|
8406
|
+
* The authentication object.
|
|
8407
|
+
*/
|
|
8408
|
+
auth?: any;
|
|
8409
|
+
/**
|
|
8410
|
+
* The Google Cloud Storage URIs to register. Example: `gs://bucket/object`.
|
|
8411
|
+
*/
|
|
8412
|
+
uris: string[];
|
|
8413
|
+
/** Used to override the default configuration. */
|
|
8414
|
+
config?: RegisterFilesConfig;
|
|
8415
|
+
}
|
|
8416
|
+
|
|
8417
|
+
/** Response for the _register file method. */
|
|
8418
|
+
export declare class RegisterFilesResponse {
|
|
8419
|
+
/** Used to retain the full HTTP response. */
|
|
8420
|
+
sdkHttpResponse?: HttpResponse;
|
|
8421
|
+
/** The registered files. */
|
|
8422
|
+
files?: File_2[];
|
|
8423
|
+
}
|
|
8424
|
+
|
|
8306
8425
|
/** Represents a recorded session. */
|
|
8307
8426
|
export declare interface ReplayFile {
|
|
8308
8427
|
replayId?: string;
|
|
@@ -8418,6 +8537,18 @@ declare type RequestOptions = {
|
|
|
8418
8537
|
__streamClass?: typeof Stream;
|
|
8419
8538
|
};
|
|
8420
8539
|
|
|
8540
|
+
/** Resource scope. */
|
|
8541
|
+
export declare enum ResourceScope {
|
|
8542
|
+
/**
|
|
8543
|
+
* When setting base_url, this value configures resource scope to be the collection.
|
|
8544
|
+
The resource name will not include api version, project, or location.
|
|
8545
|
+
For example, if base_url is set to "https://aiplatform.googleapis.com",
|
|
8546
|
+
then the resource name for a Model would be
|
|
8547
|
+
"https://aiplatform.googleapis.com/publishers/google/models/gemini-3-pro-preview
|
|
8548
|
+
*/
|
|
8549
|
+
COLLECTION = "COLLECTION"
|
|
8550
|
+
}
|
|
8551
|
+
|
|
8421
8552
|
/** Defines a retrieval tool that model can call to access external knowledge. This data type is not supported in Gemini API. */
|
|
8422
8553
|
export declare interface Retrieval {
|
|
8423
8554
|
/** Optional. Deprecated. This option is no longer supported. */
|
|
@@ -9598,6 +9729,8 @@ export declare interface TuningJob {
|
|
|
9598
9729
|
supervisedTuningSpec?: SupervisedTuningSpec;
|
|
9599
9730
|
/** Tuning Spec for Preference Optimization. */
|
|
9600
9731
|
preferenceOptimizationSpec?: PreferenceOptimizationSpec;
|
|
9732
|
+
/** Tuning Spec for Distillation. */
|
|
9733
|
+
distillationSpec?: DistillationSpec;
|
|
9601
9734
|
/** Output only. The tuning data statistics associated with this TuningJob. */
|
|
9602
9735
|
tuningDataStats?: TuningDataStats;
|
|
9603
9736
|
/** Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key. */
|
|
@@ -9631,7 +9764,11 @@ export declare enum TuningMethod {
|
|
|
9631
9764
|
/**
|
|
9632
9765
|
* Preference optimization tuning.
|
|
9633
9766
|
*/
|
|
9634
|
-
PREFERENCE_TUNING = "PREFERENCE_TUNING"
|
|
9767
|
+
PREFERENCE_TUNING = "PREFERENCE_TUNING",
|
|
9768
|
+
/**
|
|
9769
|
+
* Distillation tuning.
|
|
9770
|
+
*/
|
|
9771
|
+
DISTILLATION = "DISTILLATION"
|
|
9635
9772
|
}
|
|
9636
9773
|
|
|
9637
9774
|
/** Tuning mode. This enum is not supported in Gemini API. */
|
|
@@ -9872,6 +10009,7 @@ declare namespace types {
|
|
|
9872
10009
|
JobState,
|
|
9873
10010
|
TuningTask,
|
|
9874
10011
|
PartMediaResolutionLevel,
|
|
10012
|
+
ResourceScope,
|
|
9875
10013
|
FeatureSelectionPreference,
|
|
9876
10014
|
Environment,
|
|
9877
10015
|
SafetyFilterLevel,
|
|
@@ -9968,6 +10106,7 @@ declare namespace types {
|
|
|
9968
10106
|
GenerationConfigRoutingConfigManualRoutingMode,
|
|
9969
10107
|
GenerationConfigRoutingConfig,
|
|
9970
10108
|
SafetySetting,
|
|
10109
|
+
ModelArmorConfig,
|
|
9971
10110
|
GenerateContentConfig,
|
|
9972
10111
|
GenerateContentParameters,
|
|
9973
10112
|
HttpResponse,
|
|
@@ -10074,6 +10213,8 @@ declare namespace types {
|
|
|
10074
10213
|
SupervisedTuningSpec,
|
|
10075
10214
|
PreferenceOptimizationHyperParameters,
|
|
10076
10215
|
PreferenceOptimizationSpec,
|
|
10216
|
+
DistillationHyperParameters,
|
|
10217
|
+
DistillationSpec,
|
|
10077
10218
|
GoogleRpcStatus,
|
|
10078
10219
|
PreTunedModel,
|
|
10079
10220
|
DatasetDistributionDistributionBucket,
|
|
@@ -10160,6 +10301,9 @@ declare namespace types {
|
|
|
10160
10301
|
DeleteFileConfig,
|
|
10161
10302
|
DeleteFileParameters,
|
|
10162
10303
|
DeleteFileResponse,
|
|
10304
|
+
RegisterFilesConfig,
|
|
10305
|
+
InternalRegisterFilesParameters,
|
|
10306
|
+
RegisterFilesResponse,
|
|
10163
10307
|
InlinedRequest,
|
|
10164
10308
|
BatchJobSource,
|
|
10165
10309
|
JobError,
|
|
@@ -10219,6 +10363,7 @@ declare namespace types {
|
|
|
10219
10363
|
LiveServerMessage,
|
|
10220
10364
|
OperationFromAPIResponseParameters,
|
|
10221
10365
|
GenerationConfigThinkingConfig,
|
|
10366
|
+
RegisterFilesParameters,
|
|
10222
10367
|
AutomaticActivityDetection,
|
|
10223
10368
|
RealtimeInputConfig,
|
|
10224
10369
|
SessionResumptionConfig,
|