@google/genai 1.49.0 → 1.50.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/web/web.d.ts CHANGED
@@ -476,7 +476,7 @@ declare interface AudioContent {
476
476
  /**
477
477
  * The mime type of the audio.
478
478
  */
479
- mime_type?: 'audio/wav' | 'audio/mp3' | 'audio/aiff' | 'audio/aac' | 'audio/ogg' | 'audio/flac' | 'audio/mpeg' | 'audio/m4a' | 'audio/l16';
479
+ mime_type?: 'audio/wav' | 'audio/mp3' | 'audio/aiff' | 'audio/aac' | 'audio/ogg' | 'audio/flac' | 'audio/mpeg' | 'audio/m4a' | 'audio/l16' | 'audio/opus' | 'audio/alaw' | 'audio/mulaw';
480
480
  /**
481
481
  * The sample rate of the audio.
482
482
  */
@@ -632,6 +632,18 @@ export declare interface AutomaticFunctionCallingConfig {
632
632
  ignoreCallHistory?: boolean;
633
633
  }
634
634
 
635
+ /** Configures the avatar to be used in the session. */
636
+ export declare interface AvatarConfig {
637
+ /** Pre-built avatar id. */
638
+ avatarName?: string;
639
+ /** Customized avatar appearance with a reference image. */
640
+ customizedAvatar?: CustomizedAvatar;
641
+ /** The bitrate of compressed audio. */
642
+ audioBitrateBps?: number;
643
+ /** The bitrate of compressed video output. */
644
+ videoBitrateBps?: number;
645
+ }
646
+
635
647
  declare class BadRequestError extends APIError<400, Headers> {
636
648
  }
637
649
 
@@ -695,6 +707,11 @@ declare interface BaseCreateAgentInteractionParams {
695
707
  * Body param: A list of tool declarations the model may call during interaction.
696
708
  */
697
709
  tools?: Array<Tool_2>;
710
+ /**
711
+ * Body param: Optional. Webhook configuration for receiving notifications when the
712
+ * interaction completes.
713
+ */
714
+ webhook_config?: WebhookConfig_2;
698
715
  }
699
716
 
700
717
  declare interface BaseCreateModelInteractionParams {
@@ -757,6 +774,11 @@ declare interface BaseCreateModelInteractionParams {
757
774
  * Body param: A list of tool declarations the model may call during interaction.
758
775
  */
759
776
  tools?: Array<Tool_2>;
777
+ /**
778
+ * Body param: Optional. Webhook configuration for receiving notifications when the
779
+ * interaction completes.
780
+ */
781
+ webhook_config?: WebhookConfig_2;
760
782
  }
761
783
 
762
784
  /**
@@ -858,7 +880,7 @@ declare class BaseInteractions extends APIResource {
858
880
  * ```ts
859
881
  * const interaction = await client.interactions.create({
860
882
  * api_version: 'api_version',
861
- * input: [{ text: 'text', type: 'text' }],
883
+ * input: { text: 'text', type: 'text' },
862
884
  * model: 'gemini-2.5-computer-use-preview-10-2025',
863
885
  * });
864
886
  * ```
@@ -923,6 +945,38 @@ export declare interface BaseUrlParameters {
923
945
  vertexUrl?: string;
924
946
  }
925
947
 
948
+ declare class BaseWebhooks extends APIResource {
949
+ static readonly _key: readonly ['webhooks'];
950
+ /**
951
+ * Creates a new Webhook.
952
+ */
953
+ create(params: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse>;
954
+ /**
955
+ * Gets a specific Webhook.
956
+ */
957
+ retrieve(id: string, params?: WebhookRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<WebhookRetrieveResponse>;
958
+ /**
959
+ * Updates an existing Webhook.
960
+ */
961
+ update(id: string, params: WebhookUpdateParams, options?: RequestOptions): APIPromise<WebhookUpdateResponse>;
962
+ /**
963
+ * Lists all Webhooks.
964
+ */
965
+ list(params?: WebhookListParams | null | undefined, options?: RequestOptions): APIPromise<WebhookListResponse>;
966
+ /**
967
+ * Deletes a Webhook.
968
+ */
969
+ delete(id: string, params?: WebhookDeleteParams | null | undefined, options?: RequestOptions): APIPromise<WebhookDeleteResponse>;
970
+ /**
971
+ * Sends a ping event to a Webhook.
972
+ */
973
+ ping(id: string, params?: WebhookPingParams | null | undefined, options?: RequestOptions): APIPromise<WebhookPingResponse>;
974
+ /**
975
+ * Generates a new signing secret for a Webhook.
976
+ */
977
+ rotateSigningSecret(id: string, params?: WebhookRotateSigningSecretParams | null | undefined, options?: RequestOptions): APIPromise<WebhookRotateSigningSecretResponse>;
978
+ }
979
+
926
980
  export declare class Batches extends BaseModule {
927
981
  private readonly apiClient;
928
982
  constructor(apiClient: ApiClient);
@@ -1869,7 +1923,7 @@ declare namespace ContentDelta {
1869
1923
  */
1870
1924
  channels?: number;
1871
1925
  data?: string;
1872
- mime_type?: 'audio/wav' | 'audio/mp3' | 'audio/aiff' | 'audio/aac' | 'audio/ogg' | 'audio/flac' | 'audio/mpeg' | 'audio/m4a' | 'audio/l16';
1926
+ mime_type?: 'audio/wav' | 'audio/mp3' | 'audio/aiff' | 'audio/aac' | 'audio/ogg' | 'audio/flac' | 'audio/mpeg' | 'audio/m4a' | 'audio/l16' | 'audio/opus' | 'audio/alaw' | 'audio/mulaw';
1873
1927
  /**
1874
1928
  * The sample rate of the audio.
1875
1929
  */
@@ -2357,6 +2411,10 @@ export declare interface CreateBatchJobConfig {
2357
2411
  "gs://path/to/output/data" or "bq://projectId.bqDatasetId.bqTableId".
2358
2412
  */
2359
2413
  dest?: BatchJobDestinationUnion;
2414
+ /** Webhook configuration for receiving notifications when the batch
2415
+ operation completes.
2416
+ */
2417
+ webhookConfig?: WebhookConfig;
2360
2418
  }
2361
2419
 
2362
2420
  /** Config for batches.create parameters. */
@@ -2684,6 +2742,16 @@ export declare interface CustomCodeExecutionResult {
2684
2742
  score?: number;
2685
2743
  }
2686
2744
 
2745
+ /** Configures the customized avatar to be used in the session. */
2746
+ export declare interface CustomizedAvatar {
2747
+ /** The mime type of the reference image, e.g., "image/jpeg". */
2748
+ imageMimeType?: string;
2749
+ /** The data of the reference image. The dimensions of the reference
2750
+ image should be 9:16 (portrait) with a minimum resolution of 704x1280.
2751
+ * @remarks Encoded as base64 string. */
2752
+ imageData?: string;
2753
+ }
2754
+
2687
2755
  /** User provided metadata stored as key-value pairs. This data type is not supported in Vertex AI. */
2688
2756
  export declare interface CustomMetadata {
2689
2757
  /** Required. The key of the metadata to store. */
@@ -2761,10 +2829,21 @@ export declare interface DatasetStats {
2761
2829
  */
2762
2830
  declare interface DeepResearchAgentConfig {
2763
2831
  type: 'deep-research';
2832
+ /**
2833
+ * Enables human-in-the-loop planning for the Deep Research agent. If set to true,
2834
+ * the Deep Research agent will provide a research plan in its response. The agent
2835
+ * will then proceed only if the user confirms the plan in the next turn. Relevant
2836
+ * issue: b/482352502.
2837
+ */
2838
+ collaborative_planning?: boolean;
2764
2839
  /**
2765
2840
  * Whether to include thought summaries in the response.
2766
2841
  */
2767
2842
  thinking_summaries?: 'auto' | 'none';
2843
+ /**
2844
+ * Whether to include visualizations in the response.
2845
+ */
2846
+ visualization?: 'off' | 'auto';
2768
2847
  }
2769
2848
 
2770
2849
  /** Optional parameters for models.get method. */
@@ -3276,6 +3355,14 @@ export declare interface EmbedContentConfig {
3276
3355
  will lead to an INVALID_ARGUMENT error, similar to other text APIs.
3277
3356
  */
3278
3357
  autoTruncate?: boolean;
3358
+ /** Vertex API only. Whether to enable OCR for document content.
3359
+ Only applicable to Gemini Embedding 2 models.
3360
+ */
3361
+ documentOcr?: boolean;
3362
+ /** Vertex API only. Whether to extract audio from video content.
3363
+ Only applicable to Gemini Embedding 2 models.
3364
+ */
3365
+ audioTrackExtraction?: boolean;
3279
3366
  }
3280
3367
 
3281
3368
  /** Request-level metadata for the Vertex Embed Content API. */
@@ -4859,6 +4946,9 @@ export declare interface GenerateVideosConfig {
4859
4946
  compressionQuality?: VideoCompressionQuality;
4860
4947
  /** User specified labels to track billing usage. */
4861
4948
  labels?: Record<string, string>;
4949
+ /** Webhook configuration for receiving notifications when the
4950
+ video generation operation completes. */
4951
+ webhookConfig?: WebhookConfig;
4862
4952
  }
4863
4953
 
4864
4954
  /** A video generation operation. */
@@ -5273,7 +5363,11 @@ export declare class GoogleGenAI {
5273
5363
  readonly tunings: Tunings;
5274
5364
  readonly fileSearchStores: FileSearchStores;
5275
5365
  private _interactions;
5366
+ private _webhooks;
5367
+ private _nextGenClient;
5368
+ private getNextGenClient;
5276
5369
  get interactions(): Interactions;
5370
+ get webhooks(): Webhooks;
5277
5371
  constructor(options: GoogleGenAIOptions);
5278
5372
  }
5279
5373
 
@@ -6316,6 +6410,11 @@ declare interface Interaction {
6316
6410
  * Output only. Statistics on the interaction request's token usage.
6317
6411
  */
6318
6412
  usage?: Usage;
6413
+ /**
6414
+ * Optional. Webhook configuration for receiving notifications when the interaction
6415
+ * completes.
6416
+ */
6417
+ webhook_config?: WebhookConfig_2;
6319
6418
  }
6320
6419
 
6321
6420
  declare interface InteractionCancelParams {
@@ -6398,7 +6497,7 @@ export declare class Interactions extends BaseInteractions {
6398
6497
  }
6399
6498
 
6400
6499
  export declare namespace Interactions {
6401
- export { type AllowedTools as AllowedTools, type Annotation as Annotation, type AudioContent as AudioContent, 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 DynamicAgentConfig as DynamicAgentConfig, type ErrorEvent_2 as ErrorEvent, type FileCitation as FileCitation, 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 GoogleMapsCallArguments as GoogleMapsCallArguments, type GoogleMapsCallContent as GoogleMapsCallContent, type GoogleMapsResult as GoogleMapsResult, type GoogleMapsResultContent as GoogleMapsResultContent, 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 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 PlaceCitation as PlaceCitation, type SpeechConfig_2 as SpeechConfig, type TextContent as TextContent, type ThinkingLevel_2 as ThinkingLevel, type ThoughtContent as ThoughtContent, type Tool_2 as Tool, type ToolChoiceConfig as ToolChoiceConfig, type ToolChoiceType as ToolChoiceType, type Turn as Turn, type URLCitation as URLCitation, 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 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, };
6500
+ export { type AllowedTools as AllowedTools, type Annotation as Annotation, type AudioContent as AudioContent, 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 DynamicAgentConfig as DynamicAgentConfig, type ErrorEvent_2 as ErrorEvent, type FileCitation as FileCitation, 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 GoogleMapsCallArguments as GoogleMapsCallArguments, type GoogleMapsCallContent as GoogleMapsCallContent, type GoogleMapsResult as GoogleMapsResult, type GoogleMapsResultContent as GoogleMapsResultContent, 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 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 PlaceCitation as PlaceCitation, type SpeechConfig_2 as SpeechConfig, type TextContent as TextContent, type ThinkingLevel_2 as ThinkingLevel, type ThoughtContent as ThoughtContent, type Tool_2 as Tool, type ToolChoiceConfig as ToolChoiceConfig, type ToolChoiceType as ToolChoiceType, type Turn as Turn, type URLCitation as URLCitation, 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 WebhookConfig_2 as WebhookConfig, 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, };
6402
6501
  }
6403
6502
 
6404
6503
  declare namespace InteractionsAPI {
@@ -6460,6 +6559,7 @@ declare namespace InteractionsAPI {
6460
6559
  URLContextResultContent,
6461
6560
  Usage,
6462
6561
  VideoContent,
6562
+ WebhookConfig_2 as WebhookConfig,
6463
6563
  InteractionDeleteResponse,
6464
6564
  InteractionCreateParams,
6465
6565
  BaseCreateModelInteractionParams,
@@ -7013,6 +7113,12 @@ export declare interface LiveClientSetup {
7013
7113
  vad_signal to indicate the start and end of speech. This allows the server
7014
7114
  to process the audio more efficiently. */
7015
7115
  explicitVadSignal?: boolean;
7116
+ /** Configures the avatar model behavior. */
7117
+ avatarConfig?: AvatarConfig;
7118
+ /** Safety settings in the request to block unsafe content in the
7119
+ response.
7120
+ */
7121
+ safetySettings?: SafetySetting[];
7016
7122
  }
7017
7123
 
7018
7124
  /** Client generated response to a `ToolCall` received from the server.
@@ -7119,6 +7225,12 @@ export declare interface LiveConnectConfig {
7119
7225
  vad_signal to indicate the start and end of speech. This allows the server
7120
7226
  to process the audio more efficiently. */
7121
7227
  explicitVadSignal?: boolean;
7228
+ /** Configures the avatar model behavior. */
7229
+ avatarConfig?: AvatarConfig;
7230
+ /** Safety settings in the request to block unsafe content in the
7231
+ response.
7232
+ */
7233
+ safetySettings?: SafetySetting[];
7122
7234
  }
7123
7235
 
7124
7236
  /** Config for LiveConnectConstraints for Auth Token creation. */
@@ -7820,7 +7932,11 @@ export declare enum Modality {
7820
7932
  /**
7821
7933
  * Indicates the model should return audio.
7822
7934
  */
7823
- AUDIO = "AUDIO"
7935
+ AUDIO = "AUDIO",
7936
+ /**
7937
+ * Indicates the model should return video.
7938
+ */
7939
+ VIDEO = "VIDEO"
7824
7940
  }
7825
7941
 
7826
7942
  /** Represents token counting info for a single modality. */
@@ -10926,7 +11042,103 @@ export declare enum TurnCompleteReason {
10926
11042
  /**
10927
11043
  * Needs more input from the user.
10928
11044
  */
10929
- NEED_MORE_INPUT = "NEED_MORE_INPUT"
11045
+ NEED_MORE_INPUT = "NEED_MORE_INPUT",
11046
+ /**
11047
+ * Input content is prohibited.
11048
+ */
11049
+ PROHIBITED_INPUT_CONTENT = "PROHIBITED_INPUT_CONTENT",
11050
+ /**
11051
+ * Input image contains prohibited content.
11052
+ */
11053
+ IMAGE_PROHIBITED_INPUT_CONTENT = "IMAGE_PROHIBITED_INPUT_CONTENT",
11054
+ /**
11055
+ * Input text contains prominent person reference.
11056
+ */
11057
+ INPUT_TEXT_CONTAIN_PROMINENT_PERSON_PROHIBITED = "INPUT_TEXT_CONTAIN_PROMINENT_PERSON_PROHIBITED",
11058
+ /**
11059
+ * Input image contains celebrity.
11060
+ */
11061
+ INPUT_IMAGE_CELEBRITY = "INPUT_IMAGE_CELEBRITY",
11062
+ /**
11063
+ * Input image contains photo realistic child.
11064
+ */
11065
+ INPUT_IMAGE_PHOTO_REALISTIC_CHILD_PROHIBITED = "INPUT_IMAGE_PHOTO_REALISTIC_CHILD_PROHIBITED",
11066
+ /**
11067
+ * Input text contains NCII content.
11068
+ */
11069
+ INPUT_TEXT_NCII_PROHIBITED = "INPUT_TEXT_NCII_PROHIBITED",
11070
+ /**
11071
+ * Other input safety issue.
11072
+ */
11073
+ INPUT_OTHER = "INPUT_OTHER",
11074
+ /**
11075
+ * Input contains IP violation.
11076
+ */
11077
+ INPUT_IP_PROHIBITED = "INPUT_IP_PROHIBITED",
11078
+ /**
11079
+ * Input matched blocklist.
11080
+ */
11081
+ BLOCKLIST = "BLOCKLIST",
11082
+ /**
11083
+ * Input is unsafe for image generation.
11084
+ */
11085
+ UNSAFE_PROMPT_FOR_IMAGE_GENERATION = "UNSAFE_PROMPT_FOR_IMAGE_GENERATION",
11086
+ /**
11087
+ * Generated image failed safety check.
11088
+ */
11089
+ GENERATED_IMAGE_SAFETY = "GENERATED_IMAGE_SAFETY",
11090
+ /**
11091
+ * Generated content failed safety check.
11092
+ */
11093
+ GENERATED_CONTENT_SAFETY = "GENERATED_CONTENT_SAFETY",
11094
+ /**
11095
+ * Generated audio failed safety check.
11096
+ */
11097
+ GENERATED_AUDIO_SAFETY = "GENERATED_AUDIO_SAFETY",
11098
+ /**
11099
+ * Generated video failed safety check.
11100
+ */
11101
+ GENERATED_VIDEO_SAFETY = "GENERATED_VIDEO_SAFETY",
11102
+ /**
11103
+ * Generated content is prohibited.
11104
+ */
11105
+ GENERATED_CONTENT_PROHIBITED = "GENERATED_CONTENT_PROHIBITED",
11106
+ /**
11107
+ * Generated content matched blocklist.
11108
+ */
11109
+ GENERATED_CONTENT_BLOCKLIST = "GENERATED_CONTENT_BLOCKLIST",
11110
+ /**
11111
+ * Generated image is prohibited.
11112
+ */
11113
+ GENERATED_IMAGE_PROHIBITED = "GENERATED_IMAGE_PROHIBITED",
11114
+ /**
11115
+ * Generated image contains celebrity.
11116
+ */
11117
+ GENERATED_IMAGE_CELEBRITY = "GENERATED_IMAGE_CELEBRITY",
11118
+ /**
11119
+ * Generated image contains prominent people detected by rewriter.
11120
+ */
11121
+ GENERATED_IMAGE_PROMINENT_PEOPLE_DETECTED_BY_REWRITER = "GENERATED_IMAGE_PROMINENT_PEOPLE_DETECTED_BY_REWRITER",
11122
+ /**
11123
+ * Generated image contains identifiable people.
11124
+ */
11125
+ GENERATED_IMAGE_IDENTIFIABLE_PEOPLE = "GENERATED_IMAGE_IDENTIFIABLE_PEOPLE",
11126
+ /**
11127
+ * Generated image contains minors.
11128
+ */
11129
+ GENERATED_IMAGE_MINORS = "GENERATED_IMAGE_MINORS",
11130
+ /**
11131
+ * Generated image contains IP violation.
11132
+ */
11133
+ OUTPUT_IMAGE_IP_PROHIBITED = "OUTPUT_IMAGE_IP_PROHIBITED",
11134
+ /**
11135
+ * Other generated content issue.
11136
+ */
11137
+ GENERATED_OTHER = "GENERATED_OTHER",
11138
+ /**
11139
+ * Max regeneration attempts reached.
11140
+ */
11141
+ MAX_REGENERATION_REACHED = "MAX_REGENERATION_REACHED"
10930
11142
  }
10931
11143
 
10932
11144
  /** Options about which input is included in the user's turn. */
@@ -11239,6 +11451,7 @@ declare namespace types {
11239
11451
  GenerateVideosSource,
11240
11452
  VideoGenerationReferenceImage,
11241
11453
  VideoGenerationMask,
11454
+ WebhookConfig,
11242
11455
  GenerateVideosConfig,
11243
11456
  GenerateVideosParameters,
11244
11457
  GeneratedVideo,
@@ -11430,19 +11643,21 @@ declare namespace types {
11430
11643
  ContextWindowCompressionConfig,
11431
11644
  AudioTranscriptionConfig,
11432
11645
  ProactivityConfig,
11646
+ CustomizedAvatar,
11647
+ AvatarConfig,
11433
11648
  LiveClientSetup,
11434
11649
  LiveClientContent,
11435
11650
  ActivityStart,
11436
11651
  ActivityEnd,
11437
11652
  LiveClientRealtimeInput,
11438
11653
  LiveClientToolResponse,
11439
- LiveSendRealtimeInputParameters,
11440
11654
  LiveClientMessage,
11441
11655
  LiveConnectConfig,
11442
11656
  LiveConnectParameters,
11443
11657
  CreateChatParameters,
11444
11658
  SendMessageParameters,
11445
11659
  LiveSendClientContentParameters,
11660
+ LiveSendRealtimeInputParameters,
11446
11661
  LiveSendToolResponseParameters,
11447
11662
  LiveMusicClientSetup,
11448
11663
  WeightedPrompt,
@@ -12267,6 +12482,484 @@ export declare interface VoiceConfig {
12267
12482
  prebuiltVoiceConfig?: PrebuiltVoiceConfig;
12268
12483
  }
12269
12484
 
12485
+ /** Configuration for webhook notifications.
12486
+
12487
+ Used to configure webhook endpoints that will receive notifications
12488
+ when long-running operations (e.g., batch jobs, video generation) complete. */
12489
+ export declare interface WebhookConfig {
12490
+ /** The webhook URIs to receive notifications. If set, these
12491
+ webhook URIs will be used instead of the registered webhooks. */
12492
+ uris?: string[];
12493
+ /** User metadata that will be included in each webhook event
12494
+ notification. Use this to attach custom key-value data to correlate
12495
+ webhook events with your internal systems. */
12496
+ userMetadata?: Record<string, unknown>;
12497
+ }
12498
+
12499
+ /**
12500
+ * Message for configuring webhook events for a request.
12501
+ */
12502
+ declare interface WebhookConfig_2 {
12503
+ /**
12504
+ * Optional. If set, these webhook URIs will be used for webhook events instead of
12505
+ * the registered webhooks.
12506
+ */
12507
+ uris?: Array<string>;
12508
+ /**
12509
+ * Optional. The user metadata that will be returned on each event emission to the
12510
+ * webhooks.
12511
+ */
12512
+ user_metadata?: {
12513
+ [key: string]: unknown;
12514
+ };
12515
+ }
12516
+
12517
+ declare interface WebhookCreateParams {
12518
+ /**
12519
+ * Path param: Which version of the API to use.
12520
+ */
12521
+ api_version?: string;
12522
+ /**
12523
+ * Body param: Required. The events that the webhook is subscribed to. Available
12524
+ * events:
12525
+ *
12526
+ * - batch.succeeded
12527
+ * - batch.cancelled
12528
+ * - batch.expired
12529
+ * - batch.failed
12530
+ * - interaction.requires_action
12531
+ * - interaction.completed
12532
+ * - interaction.failed
12533
+ * - interaction.cancelled
12534
+ * - video.generated
12535
+ */
12536
+ subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12537
+ /**
12538
+ * Body param: Required. The URI to which webhook events will be sent.
12539
+ */
12540
+ uri: string;
12541
+ /**
12542
+ * Query param: Optional. The webhook_id to use for the webhook. If not specified,
12543
+ * the server will generate a unique ID.
12544
+ */
12545
+ webhook_id?: string;
12546
+ /**
12547
+ * Body param: Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12548
+ */
12549
+ name?: string;
12550
+ /**
12551
+ * Body param: The state of the webhook.
12552
+ */
12553
+ state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12554
+ }
12555
+
12556
+ /**
12557
+ * A Webhook resource.
12558
+ */
12559
+ declare interface WebhookCreateResponse {
12560
+ /**
12561
+ * Required. The events that the webhook is subscribed to. Available events:
12562
+ *
12563
+ * - batch.succeeded
12564
+ * - batch.cancelled
12565
+ * - batch.expired
12566
+ * - batch.failed
12567
+ * - interaction.requires_action
12568
+ * - interaction.completed
12569
+ * - interaction.failed
12570
+ * - interaction.cancelled
12571
+ * - video.generated
12572
+ */
12573
+ subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12574
+ /**
12575
+ * Required. The URI to which webhook events will be sent.
12576
+ */
12577
+ uri: string;
12578
+ /**
12579
+ * Output only. The timestamp when the webhook was created.
12580
+ */
12581
+ create_time?: string;
12582
+ /**
12583
+ * Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12584
+ */
12585
+ name?: string;
12586
+ /**
12587
+ * Output only. The new signing secret for the webhook. Only populated on create.
12588
+ */
12589
+ new_signing_secret?: string;
12590
+ /**
12591
+ * Output only. The signing secrets associated with this webhook.
12592
+ */
12593
+ signing_secrets?: Array<WebhookCreateResponse.SigningSecret>;
12594
+ /**
12595
+ * The state of the webhook.
12596
+ */
12597
+ state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12598
+ /**
12599
+ * Output only. The timestamp when the webhook was last updated.
12600
+ */
12601
+ update_time?: string;
12602
+ }
12603
+
12604
+ declare namespace WebhookCreateResponse {
12605
+ /**
12606
+ * Represents a signing secret used to verify webhook payloads.
12607
+ */
12608
+ interface SigningSecret {
12609
+ /**
12610
+ * Output only. The expiration date of the signing secret.
12611
+ */
12612
+ expire_time?: string;
12613
+ /**
12614
+ * Output only. The truncated version of the signing secret.
12615
+ */
12616
+ truncated_secret?: string;
12617
+ }
12618
+ }
12619
+
12620
+ declare interface WebhookDeleteParams {
12621
+ /**
12622
+ * Which version of the API to use.
12623
+ */
12624
+ api_version?: string;
12625
+ }
12626
+
12627
+ /**
12628
+ * A generic empty message that you can re-use to avoid defining duplicated empty
12629
+ * messages in your APIs. A typical example is to use it as the request or the
12630
+ * response type of an API method. For instance:
12631
+ *
12632
+ * service Foo {
12633
+ * rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
12634
+ * }
12635
+ */
12636
+ declare interface WebhookDeleteResponse {
12637
+ }
12638
+
12639
+ declare interface WebhookListParams {
12640
+ /**
12641
+ * Path param: Which version of the API to use.
12642
+ */
12643
+ api_version?: string;
12644
+ /**
12645
+ * Query param: Optional. The maximum number of webhooks to return. The service may
12646
+ * return fewer than this value. If unspecified, at most 50 webhooks will be
12647
+ * returned. The maximum value is 1000.
12648
+ */
12649
+ page_size?: number;
12650
+ /**
12651
+ * Query param: Optional. A page token, received from a previous `ListWebhooks`
12652
+ * call. Provide this to retrieve the subsequent page.
12653
+ */
12654
+ page_token?: string;
12655
+ }
12656
+
12657
+ /**
12658
+ * Response message for WebhookService.ListWebhooks.
12659
+ */
12660
+ declare interface WebhookListResponse {
12661
+ /**
12662
+ * A token, which can be sent as `page_token` to retrieve the next page. If this
12663
+ * field is omitted, there are no subsequent pages.
12664
+ */
12665
+ next_page_token?: string;
12666
+ /**
12667
+ * The webhooks.
12668
+ */
12669
+ webhooks?: Array<WebhookListResponse.Webhook>;
12670
+ }
12671
+
12672
+ declare namespace WebhookListResponse {
12673
+ /**
12674
+ * A Webhook resource.
12675
+ */
12676
+ interface Webhook {
12677
+ /**
12678
+ * Required. The events that the webhook is subscribed to. Available events:
12679
+ *
12680
+ * - batch.succeeded
12681
+ * - batch.cancelled
12682
+ * - batch.expired
12683
+ * - batch.failed
12684
+ * - interaction.requires_action
12685
+ * - interaction.completed
12686
+ * - interaction.failed
12687
+ * - interaction.cancelled
12688
+ * - video.generated
12689
+ */
12690
+ subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12691
+ /**
12692
+ * Required. The URI to which webhook events will be sent.
12693
+ */
12694
+ uri: string;
12695
+ /**
12696
+ * Output only. The timestamp when the webhook was created.
12697
+ */
12698
+ create_time?: string;
12699
+ /**
12700
+ * Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12701
+ */
12702
+ name?: string;
12703
+ /**
12704
+ * Output only. The new signing secret for the webhook. Only populated on create.
12705
+ */
12706
+ new_signing_secret?: string;
12707
+ /**
12708
+ * Output only. The signing secrets associated with this webhook.
12709
+ */
12710
+ signing_secrets?: Array<Webhook.SigningSecret>;
12711
+ /**
12712
+ * The state of the webhook.
12713
+ */
12714
+ state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12715
+ /**
12716
+ * Output only. The timestamp when the webhook was last updated.
12717
+ */
12718
+ update_time?: string;
12719
+ }
12720
+ namespace Webhook {
12721
+ /**
12722
+ * Represents a signing secret used to verify webhook payloads.
12723
+ */
12724
+ interface SigningSecret {
12725
+ /**
12726
+ * Output only. The expiration date of the signing secret.
12727
+ */
12728
+ expire_time?: string;
12729
+ /**
12730
+ * Output only. The truncated version of the signing secret.
12731
+ */
12732
+ truncated_secret?: string;
12733
+ }
12734
+ }
12735
+ }
12736
+
12737
+ declare interface WebhookPingParams {
12738
+ /**
12739
+ * Path param: Which version of the API to use.
12740
+ */
12741
+ api_version?: string;
12742
+ /**
12743
+ * Body param: Request message for WebhookService.PingWebhook.
12744
+ */
12745
+ body?: WebhookPingParams.Body;
12746
+ }
12747
+
12748
+ declare namespace WebhookPingParams {
12749
+ /**
12750
+ * Request message for WebhookService.PingWebhook.
12751
+ */
12752
+ interface Body {
12753
+ }
12754
+ }
12755
+
12756
+ /**
12757
+ * Response message for WebhookService.PingWebhook.
12758
+ */
12759
+ declare interface WebhookPingResponse {
12760
+ }
12761
+
12762
+ declare interface WebhookRetrieveParams {
12763
+ /**
12764
+ * Which version of the API to use.
12765
+ */
12766
+ api_version?: string;
12767
+ }
12768
+
12769
+ /**
12770
+ * A Webhook resource.
12771
+ */
12772
+ declare interface WebhookRetrieveResponse {
12773
+ /**
12774
+ * Required. The events that the webhook is subscribed to. Available events:
12775
+ *
12776
+ * - batch.succeeded
12777
+ * - batch.cancelled
12778
+ * - batch.expired
12779
+ * - batch.failed
12780
+ * - interaction.requires_action
12781
+ * - interaction.completed
12782
+ * - interaction.failed
12783
+ * - interaction.cancelled
12784
+ * - video.generated
12785
+ */
12786
+ subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12787
+ /**
12788
+ * Required. The URI to which webhook events will be sent.
12789
+ */
12790
+ uri: string;
12791
+ /**
12792
+ * Output only. The timestamp when the webhook was created.
12793
+ */
12794
+ create_time?: string;
12795
+ /**
12796
+ * Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12797
+ */
12798
+ name?: string;
12799
+ /**
12800
+ * Output only. The new signing secret for the webhook. Only populated on create.
12801
+ */
12802
+ new_signing_secret?: string;
12803
+ /**
12804
+ * Output only. The signing secrets associated with this webhook.
12805
+ */
12806
+ signing_secrets?: Array<WebhookRetrieveResponse.SigningSecret>;
12807
+ /**
12808
+ * The state of the webhook.
12809
+ */
12810
+ state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12811
+ /**
12812
+ * Output only. The timestamp when the webhook was last updated.
12813
+ */
12814
+ update_time?: string;
12815
+ }
12816
+
12817
+ declare namespace WebhookRetrieveResponse {
12818
+ /**
12819
+ * Represents a signing secret used to verify webhook payloads.
12820
+ */
12821
+ interface SigningSecret {
12822
+ /**
12823
+ * Output only. The expiration date of the signing secret.
12824
+ */
12825
+ expire_time?: string;
12826
+ /**
12827
+ * Output only. The truncated version of the signing secret.
12828
+ */
12829
+ truncated_secret?: string;
12830
+ }
12831
+ }
12832
+
12833
+ declare interface WebhookRotateSigningSecretParams {
12834
+ /**
12835
+ * Path param: Which version of the API to use.
12836
+ */
12837
+ api_version?: string;
12838
+ /**
12839
+ * Body param: Optional. The revocation behavior for previous signing secrets.
12840
+ */
12841
+ revocation_behavior?: 'revoke_previous_secrets_after_h24' | 'revoke_previous_secrets_immediately';
12842
+ }
12843
+
12844
+ /**
12845
+ * Response message for WebhookService.RotateSigningSecret.
12846
+ */
12847
+ declare interface WebhookRotateSigningSecretResponse {
12848
+ /**
12849
+ * Output only. The newly generated signing secret.
12850
+ */
12851
+ secret?: string;
12852
+ }
12853
+
12854
+ export declare class Webhooks extends BaseWebhooks {
12855
+ }
12856
+
12857
+ export declare namespace Webhooks {
12858
+ export { type WebhookCreateResponse as WebhookCreateResponse, type WebhookRetrieveResponse as WebhookRetrieveResponse, type WebhookUpdateResponse as WebhookUpdateResponse, type WebhookListResponse as WebhookListResponse, type WebhookDeleteResponse as WebhookDeleteResponse, type WebhookPingResponse as WebhookPingResponse, type WebhookRotateSigningSecretResponse as WebhookRotateSigningSecretResponse, type WebhookCreateParams as WebhookCreateParams, type WebhookRetrieveParams as WebhookRetrieveParams, type WebhookUpdateParams as WebhookUpdateParams, type WebhookListParams as WebhookListParams, type WebhookDeleteParams as WebhookDeleteParams, type WebhookPingParams as WebhookPingParams, type WebhookRotateSigningSecretParams as WebhookRotateSigningSecretParams, };
12859
+ }
12860
+
12861
+ declare interface WebhookUpdateParams {
12862
+ /**
12863
+ * Path param: Which version of the API to use.
12864
+ */
12865
+ api_version?: string;
12866
+ /**
12867
+ * Body param: Required. The events that the webhook is subscribed to. Available
12868
+ * events:
12869
+ *
12870
+ * - batch.succeeded
12871
+ * - batch.cancelled
12872
+ * - batch.expired
12873
+ * - batch.failed
12874
+ * - interaction.requires_action
12875
+ * - interaction.completed
12876
+ * - interaction.failed
12877
+ * - interaction.cancelled
12878
+ * - video.generated
12879
+ */
12880
+ subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12881
+ /**
12882
+ * Body param: Required. The URI to which webhook events will be sent.
12883
+ */
12884
+ uri: string;
12885
+ /**
12886
+ * Query param: Optional. The list of fields to update.
12887
+ */
12888
+ update_mask?: string;
12889
+ /**
12890
+ * Body param: Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12891
+ */
12892
+ name?: string;
12893
+ /**
12894
+ * Body param: The state of the webhook.
12895
+ */
12896
+ state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12897
+ }
12898
+
12899
+ /**
12900
+ * A Webhook resource.
12901
+ */
12902
+ declare interface WebhookUpdateResponse {
12903
+ /**
12904
+ * Required. The events that the webhook is subscribed to. Available events:
12905
+ *
12906
+ * - batch.succeeded
12907
+ * - batch.cancelled
12908
+ * - batch.expired
12909
+ * - batch.failed
12910
+ * - interaction.requires_action
12911
+ * - interaction.completed
12912
+ * - interaction.failed
12913
+ * - interaction.cancelled
12914
+ * - video.generated
12915
+ */
12916
+ subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12917
+ /**
12918
+ * Required. The URI to which webhook events will be sent.
12919
+ */
12920
+ uri: string;
12921
+ /**
12922
+ * Output only. The timestamp when the webhook was created.
12923
+ */
12924
+ create_time?: string;
12925
+ /**
12926
+ * Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12927
+ */
12928
+ name?: string;
12929
+ /**
12930
+ * Output only. The new signing secret for the webhook. Only populated on create.
12931
+ */
12932
+ new_signing_secret?: string;
12933
+ /**
12934
+ * Output only. The signing secrets associated with this webhook.
12935
+ */
12936
+ signing_secrets?: Array<WebhookUpdateResponse.SigningSecret>;
12937
+ /**
12938
+ * The state of the webhook.
12939
+ */
12940
+ state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12941
+ /**
12942
+ * Output only. The timestamp when the webhook was last updated.
12943
+ */
12944
+ update_time?: string;
12945
+ }
12946
+
12947
+ declare namespace WebhookUpdateResponse {
12948
+ /**
12949
+ * Represents a signing secret used to verify webhook payloads.
12950
+ */
12951
+ interface SigningSecret {
12952
+ /**
12953
+ * Output only. The expiration date of the signing secret.
12954
+ */
12955
+ expire_time?: string;
12956
+ /**
12957
+ * Output only. The truncated version of the signing secret.
12958
+ */
12959
+ truncated_secret?: string;
12960
+ }
12961
+ }
12962
+
12270
12963
  /** Standard web search for grounding and related configurations. Only text results are returned. */
12271
12964
  export declare interface WebSearch {
12272
12965
  }