@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/genai.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. */
|
|
@@ -5369,6 +5416,8 @@ declare type HTTPMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
|
|
|
5369
5416
|
export declare interface HttpOptions {
|
|
5370
5417
|
/** The base URL for the AI platform service endpoint. */
|
|
5371
5418
|
baseUrl?: string;
|
|
5419
|
+
/** The resource scope used to constructing the resource name when base_url is set */
|
|
5420
|
+
baseUrlResourceScope?: ResourceScope;
|
|
5372
5421
|
/** Specifies the version of the API to use. */
|
|
5373
5422
|
apiVersion?: string;
|
|
5374
5423
|
/** Additional HTTP headers to be sent with the request. */
|
|
@@ -5637,6 +5686,8 @@ export declare class InlinedResponse {
|
|
|
5637
5686
|
/** The response to the request.
|
|
5638
5687
|
*/
|
|
5639
5688
|
response?: GenerateContentResponse;
|
|
5689
|
+
/** The metadata to be associated with the request. */
|
|
5690
|
+
metadata?: Record<string, string>;
|
|
5640
5691
|
/** The error encountered while processing the request.
|
|
5641
5692
|
*/
|
|
5642
5693
|
error?: JobError;
|
|
@@ -5697,6 +5748,18 @@ declare interface InteractionCancelParams {
|
|
|
5697
5748
|
api_version?: string;
|
|
5698
5749
|
}
|
|
5699
5750
|
|
|
5751
|
+
declare interface InteractionCompleteEvent {
|
|
5752
|
+
/**
|
|
5753
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
5754
|
+
*/
|
|
5755
|
+
event_id?: string;
|
|
5756
|
+
event_type?: 'interaction.complete';
|
|
5757
|
+
/**
|
|
5758
|
+
* The Interaction resource.
|
|
5759
|
+
*/
|
|
5760
|
+
interaction?: Interaction;
|
|
5761
|
+
}
|
|
5762
|
+
|
|
5700
5763
|
declare type InteractionCreateParams = CreateModelInteractionParamsNonStreaming | CreateModelInteractionParamsStreaming | CreateAgentInteractionParamsNonStreaming | CreateAgentInteractionParamsStreaming;
|
|
5701
5764
|
|
|
5702
5765
|
declare interface InteractionDeleteParams {
|
|
@@ -5708,18 +5771,6 @@ declare interface InteractionDeleteParams {
|
|
|
5708
5771
|
|
|
5709
5772
|
declare type InteractionDeleteResponse = unknown;
|
|
5710
5773
|
|
|
5711
|
-
declare interface InteractionEvent {
|
|
5712
|
-
/**
|
|
5713
|
-
* The event_id token to be used to resume the interaction stream, from this event.
|
|
5714
|
-
*/
|
|
5715
|
-
event_id?: string;
|
|
5716
|
-
event_type?: 'interaction.start' | 'interaction.complete';
|
|
5717
|
-
/**
|
|
5718
|
-
* The Interaction resource.
|
|
5719
|
-
*/
|
|
5720
|
-
interaction?: Interaction;
|
|
5721
|
-
}
|
|
5722
|
-
|
|
5723
5774
|
declare type InteractionGetParams = InteractionGetParamsNonStreaming | InteractionGetParamsStreaming;
|
|
5724
5775
|
|
|
5725
5776
|
declare namespace InteractionGetParams {
|
|
@@ -5732,6 +5783,10 @@ declare interface InteractionGetParamsBase {
|
|
|
5732
5783
|
* Path param: Which version of the API to use.
|
|
5733
5784
|
*/
|
|
5734
5785
|
api_version?: string;
|
|
5786
|
+
/**
|
|
5787
|
+
* Query param: If set to true, includes the input in the response.
|
|
5788
|
+
*/
|
|
5789
|
+
include_input?: boolean;
|
|
5735
5790
|
/**
|
|
5736
5791
|
* 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.
|
|
5737
5792
|
*/
|
|
@@ -5760,7 +5815,7 @@ export declare class Interactions extends BaseInteractions {
|
|
|
5760
5815
|
}
|
|
5761
5816
|
|
|
5762
5817
|
export declare namespace Interactions {
|
|
5763
|
-
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
|
|
5818
|
+
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, };
|
|
5764
5819
|
}
|
|
5765
5820
|
|
|
5766
5821
|
declare namespace InteractionsAPI {
|
|
@@ -5797,8 +5852,9 @@ declare namespace InteractionsAPI {
|
|
|
5797
5852
|
ImageContent,
|
|
5798
5853
|
ImageMimeType,
|
|
5799
5854
|
Interaction,
|
|
5800
|
-
|
|
5855
|
+
InteractionCompleteEvent,
|
|
5801
5856
|
InteractionSSEEvent,
|
|
5857
|
+
InteractionStartEvent,
|
|
5802
5858
|
InteractionStatusUpdate,
|
|
5803
5859
|
MCPServerToolCallContent,
|
|
5804
5860
|
MCPServerToolResultContent,
|
|
@@ -5836,7 +5892,19 @@ declare namespace InteractionsAPI {
|
|
|
5836
5892
|
}
|
|
5837
5893
|
}
|
|
5838
5894
|
|
|
5839
|
-
declare type InteractionSSEEvent =
|
|
5895
|
+
declare type InteractionSSEEvent = InteractionStartEvent | InteractionCompleteEvent | InteractionStatusUpdate | ContentStart | ContentDelta | ContentStop | ErrorEvent_2;
|
|
5896
|
+
|
|
5897
|
+
declare interface InteractionStartEvent {
|
|
5898
|
+
/**
|
|
5899
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
5900
|
+
*/
|
|
5901
|
+
event_id?: string;
|
|
5902
|
+
event_type?: 'interaction.start';
|
|
5903
|
+
/**
|
|
5904
|
+
* The Interaction resource.
|
|
5905
|
+
*/
|
|
5906
|
+
interaction?: Interaction;
|
|
5907
|
+
}
|
|
5840
5908
|
|
|
5841
5909
|
declare interface InteractionStatusUpdate {
|
|
5842
5910
|
/**
|
|
@@ -5848,6 +5916,14 @@ declare interface InteractionStatusUpdate {
|
|
|
5848
5916
|
status?: 'in_progress' | 'requires_action' | 'completed' | 'failed' | 'cancelled';
|
|
5849
5917
|
}
|
|
5850
5918
|
|
|
5919
|
+
/** Parameters for the private _Register method. */
|
|
5920
|
+
export declare interface InternalRegisterFilesParameters {
|
|
5921
|
+
/** The Google Cloud Storage URIs to register. Example: `gs://bucket/object`. */
|
|
5922
|
+
uris: string[];
|
|
5923
|
+
/** Used to override the default configuration. */
|
|
5924
|
+
config?: RegisterFilesConfig;
|
|
5925
|
+
}
|
|
5926
|
+
|
|
5851
5927
|
declare class InternalServerError extends APIError<number, Headers> {
|
|
5852
5928
|
}
|
|
5853
5929
|
|
|
@@ -7217,6 +7293,14 @@ export declare interface Model {
|
|
|
7217
7293
|
*/
|
|
7218
7294
|
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 & {});
|
|
7219
7295
|
|
|
7296
|
+
/** Configuration for Model Armor integrations of prompt and responses. This data type is not supported in Gemini API. */
|
|
7297
|
+
export declare interface ModelArmorConfig {
|
|
7298
|
+
/** Optional. The name of the Model Armor template to use for prompt sanitization. */
|
|
7299
|
+
promptTemplateName?: string;
|
|
7300
|
+
/** Optional. The name of the Model Armor template to use for response sanitization. */
|
|
7301
|
+
responseTemplateName?: string;
|
|
7302
|
+
}
|
|
7303
|
+
|
|
7220
7304
|
export declare class Models extends BaseModule {
|
|
7221
7305
|
private readonly apiClient;
|
|
7222
7306
|
constructor(apiClient: ApiClient);
|
|
@@ -8298,6 +8382,41 @@ declare interface ReferenceImageAPIInternal {
|
|
|
8298
8382
|
subjectImageConfig?: types.SubjectReferenceConfig;
|
|
8299
8383
|
}
|
|
8300
8384
|
|
|
8385
|
+
/** Used to override the default configuration. */
|
|
8386
|
+
export declare interface RegisterFilesConfig {
|
|
8387
|
+
/** Used to override HTTP request options. */
|
|
8388
|
+
httpOptions?: HttpOptions;
|
|
8389
|
+
/** Abort signal which can be used to cancel the request.
|
|
8390
|
+
|
|
8391
|
+
NOTE: AbortSignal is a client-only operation. Using it to cancel an
|
|
8392
|
+
operation will not cancel the request in the service. You will still
|
|
8393
|
+
be charged usage for any applicable operations.
|
|
8394
|
+
*/
|
|
8395
|
+
abortSignal?: AbortSignal;
|
|
8396
|
+
}
|
|
8397
|
+
|
|
8398
|
+
/** Generates the parameters for the private registerFiles method. */
|
|
8399
|
+
export declare interface RegisterFilesParameters {
|
|
8400
|
+
/**
|
|
8401
|
+
* The authentication object.
|
|
8402
|
+
*/
|
|
8403
|
+
auth?: any;
|
|
8404
|
+
/**
|
|
8405
|
+
* The Google Cloud Storage URIs to register. Example: `gs://bucket/object`.
|
|
8406
|
+
*/
|
|
8407
|
+
uris: string[];
|
|
8408
|
+
/** Used to override the default configuration. */
|
|
8409
|
+
config?: RegisterFilesConfig;
|
|
8410
|
+
}
|
|
8411
|
+
|
|
8412
|
+
/** Response for the _register file method. */
|
|
8413
|
+
export declare class RegisterFilesResponse {
|
|
8414
|
+
/** Used to retain the full HTTP response. */
|
|
8415
|
+
sdkHttpResponse?: HttpResponse;
|
|
8416
|
+
/** The registered files. */
|
|
8417
|
+
files?: File_2[];
|
|
8418
|
+
}
|
|
8419
|
+
|
|
8301
8420
|
/** Represents a recorded session. */
|
|
8302
8421
|
export declare interface ReplayFile {
|
|
8303
8422
|
replayId?: string;
|
|
@@ -8413,6 +8532,18 @@ declare type RequestOptions = {
|
|
|
8413
8532
|
__streamClass?: typeof Stream;
|
|
8414
8533
|
};
|
|
8415
8534
|
|
|
8535
|
+
/** Resource scope. */
|
|
8536
|
+
export declare enum ResourceScope {
|
|
8537
|
+
/**
|
|
8538
|
+
* When setting base_url, this value configures resource scope to be the collection.
|
|
8539
|
+
The resource name will not include api version, project, or location.
|
|
8540
|
+
For example, if base_url is set to "https://aiplatform.googleapis.com",
|
|
8541
|
+
then the resource name for a Model would be
|
|
8542
|
+
"https://aiplatform.googleapis.com/publishers/google/models/gemini-3-pro-preview
|
|
8543
|
+
*/
|
|
8544
|
+
COLLECTION = "COLLECTION"
|
|
8545
|
+
}
|
|
8546
|
+
|
|
8416
8547
|
/** Defines a retrieval tool that model can call to access external knowledge. This data type is not supported in Gemini API. */
|
|
8417
8548
|
export declare interface Retrieval {
|
|
8418
8549
|
/** Optional. Deprecated. This option is no longer supported. */
|
|
@@ -9593,6 +9724,8 @@ export declare interface TuningJob {
|
|
|
9593
9724
|
supervisedTuningSpec?: SupervisedTuningSpec;
|
|
9594
9725
|
/** Tuning Spec for Preference Optimization. */
|
|
9595
9726
|
preferenceOptimizationSpec?: PreferenceOptimizationSpec;
|
|
9727
|
+
/** Tuning Spec for Distillation. */
|
|
9728
|
+
distillationSpec?: DistillationSpec;
|
|
9596
9729
|
/** Output only. The tuning data statistics associated with this TuningJob. */
|
|
9597
9730
|
tuningDataStats?: TuningDataStats;
|
|
9598
9731
|
/** 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. */
|
|
@@ -9626,7 +9759,11 @@ export declare enum TuningMethod {
|
|
|
9626
9759
|
/**
|
|
9627
9760
|
* Preference optimization tuning.
|
|
9628
9761
|
*/
|
|
9629
|
-
PREFERENCE_TUNING = "PREFERENCE_TUNING"
|
|
9762
|
+
PREFERENCE_TUNING = "PREFERENCE_TUNING",
|
|
9763
|
+
/**
|
|
9764
|
+
* Distillation tuning.
|
|
9765
|
+
*/
|
|
9766
|
+
DISTILLATION = "DISTILLATION"
|
|
9630
9767
|
}
|
|
9631
9768
|
|
|
9632
9769
|
/** Tuning mode. This enum is not supported in Gemini API. */
|
|
@@ -9867,6 +10004,7 @@ declare namespace types {
|
|
|
9867
10004
|
JobState,
|
|
9868
10005
|
TuningTask,
|
|
9869
10006
|
PartMediaResolutionLevel,
|
|
10007
|
+
ResourceScope,
|
|
9870
10008
|
FeatureSelectionPreference,
|
|
9871
10009
|
Environment,
|
|
9872
10010
|
SafetyFilterLevel,
|
|
@@ -9963,6 +10101,7 @@ declare namespace types {
|
|
|
9963
10101
|
GenerationConfigRoutingConfigManualRoutingMode,
|
|
9964
10102
|
GenerationConfigRoutingConfig,
|
|
9965
10103
|
SafetySetting,
|
|
10104
|
+
ModelArmorConfig,
|
|
9966
10105
|
GenerateContentConfig,
|
|
9967
10106
|
GenerateContentParameters,
|
|
9968
10107
|
HttpResponse,
|
|
@@ -10069,6 +10208,8 @@ declare namespace types {
|
|
|
10069
10208
|
SupervisedTuningSpec,
|
|
10070
10209
|
PreferenceOptimizationHyperParameters,
|
|
10071
10210
|
PreferenceOptimizationSpec,
|
|
10211
|
+
DistillationHyperParameters,
|
|
10212
|
+
DistillationSpec,
|
|
10072
10213
|
GoogleRpcStatus,
|
|
10073
10214
|
PreTunedModel,
|
|
10074
10215
|
DatasetDistributionDistributionBucket,
|
|
@@ -10155,6 +10296,9 @@ declare namespace types {
|
|
|
10155
10296
|
DeleteFileConfig,
|
|
10156
10297
|
DeleteFileParameters,
|
|
10157
10298
|
DeleteFileResponse,
|
|
10299
|
+
RegisterFilesConfig,
|
|
10300
|
+
InternalRegisterFilesParameters,
|
|
10301
|
+
RegisterFilesResponse,
|
|
10158
10302
|
InlinedRequest,
|
|
10159
10303
|
BatchJobSource,
|
|
10160
10304
|
JobError,
|
|
@@ -10214,6 +10358,7 @@ declare namespace types {
|
|
|
10214
10358
|
LiveServerMessage,
|
|
10215
10359
|
OperationFromAPIResponseParameters,
|
|
10216
10360
|
GenerationConfigThinkingConfig,
|
|
10361
|
+
RegisterFilesParameters,
|
|
10217
10362
|
AutomaticActivityDetection,
|
|
10218
10363
|
RealtimeInputConfig,
|
|
10219
10364
|
SessionResumptionConfig,
|