@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/genai.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. */
@@ -5268,7 +5358,11 @@ export declare class GoogleGenAI {
5268
5358
  readonly tunings: Tunings;
5269
5359
  readonly fileSearchStores: FileSearchStores;
5270
5360
  private _interactions;
5361
+ private _webhooks;
5362
+ private _nextGenClient;
5363
+ private getNextGenClient;
5271
5364
  get interactions(): Interactions;
5365
+ get webhooks(): Webhooks;
5272
5366
  constructor(options: GoogleGenAIOptions);
5273
5367
  }
5274
5368
 
@@ -6311,6 +6405,11 @@ declare interface Interaction {
6311
6405
  * Output only. Statistics on the interaction request's token usage.
6312
6406
  */
6313
6407
  usage?: Usage;
6408
+ /**
6409
+ * Optional. Webhook configuration for receiving notifications when the interaction
6410
+ * completes.
6411
+ */
6412
+ webhook_config?: WebhookConfig_2;
6314
6413
  }
6315
6414
 
6316
6415
  declare interface InteractionCancelParams {
@@ -6393,7 +6492,7 @@ export declare class Interactions extends BaseInteractions {
6393
6492
  }
6394
6493
 
6395
6494
  export declare namespace Interactions {
6396
- 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, };
6495
+ 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, };
6397
6496
  }
6398
6497
 
6399
6498
  declare namespace InteractionsAPI {
@@ -6455,6 +6554,7 @@ declare namespace InteractionsAPI {
6455
6554
  URLContextResultContent,
6456
6555
  Usage,
6457
6556
  VideoContent,
6557
+ WebhookConfig_2 as WebhookConfig,
6458
6558
  InteractionDeleteResponse,
6459
6559
  InteractionCreateParams,
6460
6560
  BaseCreateModelInteractionParams,
@@ -7008,6 +7108,12 @@ export declare interface LiveClientSetup {
7008
7108
  vad_signal to indicate the start and end of speech. This allows the server
7009
7109
  to process the audio more efficiently. */
7010
7110
  explicitVadSignal?: boolean;
7111
+ /** Configures the avatar model behavior. */
7112
+ avatarConfig?: AvatarConfig;
7113
+ /** Safety settings in the request to block unsafe content in the
7114
+ response.
7115
+ */
7116
+ safetySettings?: SafetySetting[];
7011
7117
  }
7012
7118
 
7013
7119
  /** Client generated response to a `ToolCall` received from the server.
@@ -7114,6 +7220,12 @@ export declare interface LiveConnectConfig {
7114
7220
  vad_signal to indicate the start and end of speech. This allows the server
7115
7221
  to process the audio more efficiently. */
7116
7222
  explicitVadSignal?: boolean;
7223
+ /** Configures the avatar model behavior. */
7224
+ avatarConfig?: AvatarConfig;
7225
+ /** Safety settings in the request to block unsafe content in the
7226
+ response.
7227
+ */
7228
+ safetySettings?: SafetySetting[];
7117
7229
  }
7118
7230
 
7119
7231
  /** Config for LiveConnectConstraints for Auth Token creation. */
@@ -7815,7 +7927,11 @@ export declare enum Modality {
7815
7927
  /**
7816
7928
  * Indicates the model should return audio.
7817
7929
  */
7818
- AUDIO = "AUDIO"
7930
+ AUDIO = "AUDIO",
7931
+ /**
7932
+ * Indicates the model should return video.
7933
+ */
7934
+ VIDEO = "VIDEO"
7819
7935
  }
7820
7936
 
7821
7937
  /** Represents token counting info for a single modality. */
@@ -10921,7 +11037,103 @@ export declare enum TurnCompleteReason {
10921
11037
  /**
10922
11038
  * Needs more input from the user.
10923
11039
  */
10924
- NEED_MORE_INPUT = "NEED_MORE_INPUT"
11040
+ NEED_MORE_INPUT = "NEED_MORE_INPUT",
11041
+ /**
11042
+ * Input content is prohibited.
11043
+ */
11044
+ PROHIBITED_INPUT_CONTENT = "PROHIBITED_INPUT_CONTENT",
11045
+ /**
11046
+ * Input image contains prohibited content.
11047
+ */
11048
+ IMAGE_PROHIBITED_INPUT_CONTENT = "IMAGE_PROHIBITED_INPUT_CONTENT",
11049
+ /**
11050
+ * Input text contains prominent person reference.
11051
+ */
11052
+ INPUT_TEXT_CONTAIN_PROMINENT_PERSON_PROHIBITED = "INPUT_TEXT_CONTAIN_PROMINENT_PERSON_PROHIBITED",
11053
+ /**
11054
+ * Input image contains celebrity.
11055
+ */
11056
+ INPUT_IMAGE_CELEBRITY = "INPUT_IMAGE_CELEBRITY",
11057
+ /**
11058
+ * Input image contains photo realistic child.
11059
+ */
11060
+ INPUT_IMAGE_PHOTO_REALISTIC_CHILD_PROHIBITED = "INPUT_IMAGE_PHOTO_REALISTIC_CHILD_PROHIBITED",
11061
+ /**
11062
+ * Input text contains NCII content.
11063
+ */
11064
+ INPUT_TEXT_NCII_PROHIBITED = "INPUT_TEXT_NCII_PROHIBITED",
11065
+ /**
11066
+ * Other input safety issue.
11067
+ */
11068
+ INPUT_OTHER = "INPUT_OTHER",
11069
+ /**
11070
+ * Input contains IP violation.
11071
+ */
11072
+ INPUT_IP_PROHIBITED = "INPUT_IP_PROHIBITED",
11073
+ /**
11074
+ * Input matched blocklist.
11075
+ */
11076
+ BLOCKLIST = "BLOCKLIST",
11077
+ /**
11078
+ * Input is unsafe for image generation.
11079
+ */
11080
+ UNSAFE_PROMPT_FOR_IMAGE_GENERATION = "UNSAFE_PROMPT_FOR_IMAGE_GENERATION",
11081
+ /**
11082
+ * Generated image failed safety check.
11083
+ */
11084
+ GENERATED_IMAGE_SAFETY = "GENERATED_IMAGE_SAFETY",
11085
+ /**
11086
+ * Generated content failed safety check.
11087
+ */
11088
+ GENERATED_CONTENT_SAFETY = "GENERATED_CONTENT_SAFETY",
11089
+ /**
11090
+ * Generated audio failed safety check.
11091
+ */
11092
+ GENERATED_AUDIO_SAFETY = "GENERATED_AUDIO_SAFETY",
11093
+ /**
11094
+ * Generated video failed safety check.
11095
+ */
11096
+ GENERATED_VIDEO_SAFETY = "GENERATED_VIDEO_SAFETY",
11097
+ /**
11098
+ * Generated content is prohibited.
11099
+ */
11100
+ GENERATED_CONTENT_PROHIBITED = "GENERATED_CONTENT_PROHIBITED",
11101
+ /**
11102
+ * Generated content matched blocklist.
11103
+ */
11104
+ GENERATED_CONTENT_BLOCKLIST = "GENERATED_CONTENT_BLOCKLIST",
11105
+ /**
11106
+ * Generated image is prohibited.
11107
+ */
11108
+ GENERATED_IMAGE_PROHIBITED = "GENERATED_IMAGE_PROHIBITED",
11109
+ /**
11110
+ * Generated image contains celebrity.
11111
+ */
11112
+ GENERATED_IMAGE_CELEBRITY = "GENERATED_IMAGE_CELEBRITY",
11113
+ /**
11114
+ * Generated image contains prominent people detected by rewriter.
11115
+ */
11116
+ GENERATED_IMAGE_PROMINENT_PEOPLE_DETECTED_BY_REWRITER = "GENERATED_IMAGE_PROMINENT_PEOPLE_DETECTED_BY_REWRITER",
11117
+ /**
11118
+ * Generated image contains identifiable people.
11119
+ */
11120
+ GENERATED_IMAGE_IDENTIFIABLE_PEOPLE = "GENERATED_IMAGE_IDENTIFIABLE_PEOPLE",
11121
+ /**
11122
+ * Generated image contains minors.
11123
+ */
11124
+ GENERATED_IMAGE_MINORS = "GENERATED_IMAGE_MINORS",
11125
+ /**
11126
+ * Generated image contains IP violation.
11127
+ */
11128
+ OUTPUT_IMAGE_IP_PROHIBITED = "OUTPUT_IMAGE_IP_PROHIBITED",
11129
+ /**
11130
+ * Other generated content issue.
11131
+ */
11132
+ GENERATED_OTHER = "GENERATED_OTHER",
11133
+ /**
11134
+ * Max regeneration attempts reached.
11135
+ */
11136
+ MAX_REGENERATION_REACHED = "MAX_REGENERATION_REACHED"
10925
11137
  }
10926
11138
 
10927
11139
  /** Options about which input is included in the user's turn. */
@@ -11234,6 +11446,7 @@ declare namespace types {
11234
11446
  GenerateVideosSource,
11235
11447
  VideoGenerationReferenceImage,
11236
11448
  VideoGenerationMask,
11449
+ WebhookConfig,
11237
11450
  GenerateVideosConfig,
11238
11451
  GenerateVideosParameters,
11239
11452
  GeneratedVideo,
@@ -11425,19 +11638,21 @@ declare namespace types {
11425
11638
  ContextWindowCompressionConfig,
11426
11639
  AudioTranscriptionConfig,
11427
11640
  ProactivityConfig,
11641
+ CustomizedAvatar,
11642
+ AvatarConfig,
11428
11643
  LiveClientSetup,
11429
11644
  LiveClientContent,
11430
11645
  ActivityStart,
11431
11646
  ActivityEnd,
11432
11647
  LiveClientRealtimeInput,
11433
11648
  LiveClientToolResponse,
11434
- LiveSendRealtimeInputParameters,
11435
11649
  LiveClientMessage,
11436
11650
  LiveConnectConfig,
11437
11651
  LiveConnectParameters,
11438
11652
  CreateChatParameters,
11439
11653
  SendMessageParameters,
11440
11654
  LiveSendClientContentParameters,
11655
+ LiveSendRealtimeInputParameters,
11441
11656
  LiveSendToolResponseParameters,
11442
11657
  LiveMusicClientSetup,
11443
11658
  WeightedPrompt,
@@ -12262,6 +12477,484 @@ export declare interface VoiceConfig {
12262
12477
  prebuiltVoiceConfig?: PrebuiltVoiceConfig;
12263
12478
  }
12264
12479
 
12480
+ /** Configuration for webhook notifications.
12481
+
12482
+ Used to configure webhook endpoints that will receive notifications
12483
+ when long-running operations (e.g., batch jobs, video generation) complete. */
12484
+ export declare interface WebhookConfig {
12485
+ /** The webhook URIs to receive notifications. If set, these
12486
+ webhook URIs will be used instead of the registered webhooks. */
12487
+ uris?: string[];
12488
+ /** User metadata that will be included in each webhook event
12489
+ notification. Use this to attach custom key-value data to correlate
12490
+ webhook events with your internal systems. */
12491
+ userMetadata?: Record<string, unknown>;
12492
+ }
12493
+
12494
+ /**
12495
+ * Message for configuring webhook events for a request.
12496
+ */
12497
+ declare interface WebhookConfig_2 {
12498
+ /**
12499
+ * Optional. If set, these webhook URIs will be used for webhook events instead of
12500
+ * the registered webhooks.
12501
+ */
12502
+ uris?: Array<string>;
12503
+ /**
12504
+ * Optional. The user metadata that will be returned on each event emission to the
12505
+ * webhooks.
12506
+ */
12507
+ user_metadata?: {
12508
+ [key: string]: unknown;
12509
+ };
12510
+ }
12511
+
12512
+ declare interface WebhookCreateParams {
12513
+ /**
12514
+ * Path param: Which version of the API to use.
12515
+ */
12516
+ api_version?: string;
12517
+ /**
12518
+ * Body param: Required. The events that the webhook is subscribed to. Available
12519
+ * events:
12520
+ *
12521
+ * - batch.succeeded
12522
+ * - batch.cancelled
12523
+ * - batch.expired
12524
+ * - batch.failed
12525
+ * - interaction.requires_action
12526
+ * - interaction.completed
12527
+ * - interaction.failed
12528
+ * - interaction.cancelled
12529
+ * - video.generated
12530
+ */
12531
+ subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12532
+ /**
12533
+ * Body param: Required. The URI to which webhook events will be sent.
12534
+ */
12535
+ uri: string;
12536
+ /**
12537
+ * Query param: Optional. The webhook_id to use for the webhook. If not specified,
12538
+ * the server will generate a unique ID.
12539
+ */
12540
+ webhook_id?: string;
12541
+ /**
12542
+ * Body param: Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12543
+ */
12544
+ name?: string;
12545
+ /**
12546
+ * Body param: The state of the webhook.
12547
+ */
12548
+ state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12549
+ }
12550
+
12551
+ /**
12552
+ * A Webhook resource.
12553
+ */
12554
+ declare interface WebhookCreateResponse {
12555
+ /**
12556
+ * Required. The events that the webhook is subscribed to. Available events:
12557
+ *
12558
+ * - batch.succeeded
12559
+ * - batch.cancelled
12560
+ * - batch.expired
12561
+ * - batch.failed
12562
+ * - interaction.requires_action
12563
+ * - interaction.completed
12564
+ * - interaction.failed
12565
+ * - interaction.cancelled
12566
+ * - video.generated
12567
+ */
12568
+ subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12569
+ /**
12570
+ * Required. The URI to which webhook events will be sent.
12571
+ */
12572
+ uri: string;
12573
+ /**
12574
+ * Output only. The timestamp when the webhook was created.
12575
+ */
12576
+ create_time?: string;
12577
+ /**
12578
+ * Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12579
+ */
12580
+ name?: string;
12581
+ /**
12582
+ * Output only. The new signing secret for the webhook. Only populated on create.
12583
+ */
12584
+ new_signing_secret?: string;
12585
+ /**
12586
+ * Output only. The signing secrets associated with this webhook.
12587
+ */
12588
+ signing_secrets?: Array<WebhookCreateResponse.SigningSecret>;
12589
+ /**
12590
+ * The state of the webhook.
12591
+ */
12592
+ state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12593
+ /**
12594
+ * Output only. The timestamp when the webhook was last updated.
12595
+ */
12596
+ update_time?: string;
12597
+ }
12598
+
12599
+ declare namespace WebhookCreateResponse {
12600
+ /**
12601
+ * Represents a signing secret used to verify webhook payloads.
12602
+ */
12603
+ interface SigningSecret {
12604
+ /**
12605
+ * Output only. The expiration date of the signing secret.
12606
+ */
12607
+ expire_time?: string;
12608
+ /**
12609
+ * Output only. The truncated version of the signing secret.
12610
+ */
12611
+ truncated_secret?: string;
12612
+ }
12613
+ }
12614
+
12615
+ declare interface WebhookDeleteParams {
12616
+ /**
12617
+ * Which version of the API to use.
12618
+ */
12619
+ api_version?: string;
12620
+ }
12621
+
12622
+ /**
12623
+ * A generic empty message that you can re-use to avoid defining duplicated empty
12624
+ * messages in your APIs. A typical example is to use it as the request or the
12625
+ * response type of an API method. For instance:
12626
+ *
12627
+ * service Foo {
12628
+ * rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
12629
+ * }
12630
+ */
12631
+ declare interface WebhookDeleteResponse {
12632
+ }
12633
+
12634
+ declare interface WebhookListParams {
12635
+ /**
12636
+ * Path param: Which version of the API to use.
12637
+ */
12638
+ api_version?: string;
12639
+ /**
12640
+ * Query param: Optional. The maximum number of webhooks to return. The service may
12641
+ * return fewer than this value. If unspecified, at most 50 webhooks will be
12642
+ * returned. The maximum value is 1000.
12643
+ */
12644
+ page_size?: number;
12645
+ /**
12646
+ * Query param: Optional. A page token, received from a previous `ListWebhooks`
12647
+ * call. Provide this to retrieve the subsequent page.
12648
+ */
12649
+ page_token?: string;
12650
+ }
12651
+
12652
+ /**
12653
+ * Response message for WebhookService.ListWebhooks.
12654
+ */
12655
+ declare interface WebhookListResponse {
12656
+ /**
12657
+ * A token, which can be sent as `page_token` to retrieve the next page. If this
12658
+ * field is omitted, there are no subsequent pages.
12659
+ */
12660
+ next_page_token?: string;
12661
+ /**
12662
+ * The webhooks.
12663
+ */
12664
+ webhooks?: Array<WebhookListResponse.Webhook>;
12665
+ }
12666
+
12667
+ declare namespace WebhookListResponse {
12668
+ /**
12669
+ * A Webhook resource.
12670
+ */
12671
+ interface Webhook {
12672
+ /**
12673
+ * Required. The events that the webhook is subscribed to. Available events:
12674
+ *
12675
+ * - batch.succeeded
12676
+ * - batch.cancelled
12677
+ * - batch.expired
12678
+ * - batch.failed
12679
+ * - interaction.requires_action
12680
+ * - interaction.completed
12681
+ * - interaction.failed
12682
+ * - interaction.cancelled
12683
+ * - video.generated
12684
+ */
12685
+ subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12686
+ /**
12687
+ * Required. The URI to which webhook events will be sent.
12688
+ */
12689
+ uri: string;
12690
+ /**
12691
+ * Output only. The timestamp when the webhook was created.
12692
+ */
12693
+ create_time?: string;
12694
+ /**
12695
+ * Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12696
+ */
12697
+ name?: string;
12698
+ /**
12699
+ * Output only. The new signing secret for the webhook. Only populated on create.
12700
+ */
12701
+ new_signing_secret?: string;
12702
+ /**
12703
+ * Output only. The signing secrets associated with this webhook.
12704
+ */
12705
+ signing_secrets?: Array<Webhook.SigningSecret>;
12706
+ /**
12707
+ * The state of the webhook.
12708
+ */
12709
+ state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12710
+ /**
12711
+ * Output only. The timestamp when the webhook was last updated.
12712
+ */
12713
+ update_time?: string;
12714
+ }
12715
+ namespace Webhook {
12716
+ /**
12717
+ * Represents a signing secret used to verify webhook payloads.
12718
+ */
12719
+ interface SigningSecret {
12720
+ /**
12721
+ * Output only. The expiration date of the signing secret.
12722
+ */
12723
+ expire_time?: string;
12724
+ /**
12725
+ * Output only. The truncated version of the signing secret.
12726
+ */
12727
+ truncated_secret?: string;
12728
+ }
12729
+ }
12730
+ }
12731
+
12732
+ declare interface WebhookPingParams {
12733
+ /**
12734
+ * Path param: Which version of the API to use.
12735
+ */
12736
+ api_version?: string;
12737
+ /**
12738
+ * Body param: Request message for WebhookService.PingWebhook.
12739
+ */
12740
+ body?: WebhookPingParams.Body;
12741
+ }
12742
+
12743
+ declare namespace WebhookPingParams {
12744
+ /**
12745
+ * Request message for WebhookService.PingWebhook.
12746
+ */
12747
+ interface Body {
12748
+ }
12749
+ }
12750
+
12751
+ /**
12752
+ * Response message for WebhookService.PingWebhook.
12753
+ */
12754
+ declare interface WebhookPingResponse {
12755
+ }
12756
+
12757
+ declare interface WebhookRetrieveParams {
12758
+ /**
12759
+ * Which version of the API to use.
12760
+ */
12761
+ api_version?: string;
12762
+ }
12763
+
12764
+ /**
12765
+ * A Webhook resource.
12766
+ */
12767
+ declare interface WebhookRetrieveResponse {
12768
+ /**
12769
+ * Required. The events that the webhook is subscribed to. Available events:
12770
+ *
12771
+ * - batch.succeeded
12772
+ * - batch.cancelled
12773
+ * - batch.expired
12774
+ * - batch.failed
12775
+ * - interaction.requires_action
12776
+ * - interaction.completed
12777
+ * - interaction.failed
12778
+ * - interaction.cancelled
12779
+ * - video.generated
12780
+ */
12781
+ subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12782
+ /**
12783
+ * Required. The URI to which webhook events will be sent.
12784
+ */
12785
+ uri: string;
12786
+ /**
12787
+ * Output only. The timestamp when the webhook was created.
12788
+ */
12789
+ create_time?: string;
12790
+ /**
12791
+ * Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12792
+ */
12793
+ name?: string;
12794
+ /**
12795
+ * Output only. The new signing secret for the webhook. Only populated on create.
12796
+ */
12797
+ new_signing_secret?: string;
12798
+ /**
12799
+ * Output only. The signing secrets associated with this webhook.
12800
+ */
12801
+ signing_secrets?: Array<WebhookRetrieveResponse.SigningSecret>;
12802
+ /**
12803
+ * The state of the webhook.
12804
+ */
12805
+ state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12806
+ /**
12807
+ * Output only. The timestamp when the webhook was last updated.
12808
+ */
12809
+ update_time?: string;
12810
+ }
12811
+
12812
+ declare namespace WebhookRetrieveResponse {
12813
+ /**
12814
+ * Represents a signing secret used to verify webhook payloads.
12815
+ */
12816
+ interface SigningSecret {
12817
+ /**
12818
+ * Output only. The expiration date of the signing secret.
12819
+ */
12820
+ expire_time?: string;
12821
+ /**
12822
+ * Output only. The truncated version of the signing secret.
12823
+ */
12824
+ truncated_secret?: string;
12825
+ }
12826
+ }
12827
+
12828
+ declare interface WebhookRotateSigningSecretParams {
12829
+ /**
12830
+ * Path param: Which version of the API to use.
12831
+ */
12832
+ api_version?: string;
12833
+ /**
12834
+ * Body param: Optional. The revocation behavior for previous signing secrets.
12835
+ */
12836
+ revocation_behavior?: 'revoke_previous_secrets_after_h24' | 'revoke_previous_secrets_immediately';
12837
+ }
12838
+
12839
+ /**
12840
+ * Response message for WebhookService.RotateSigningSecret.
12841
+ */
12842
+ declare interface WebhookRotateSigningSecretResponse {
12843
+ /**
12844
+ * Output only. The newly generated signing secret.
12845
+ */
12846
+ secret?: string;
12847
+ }
12848
+
12849
+ export declare class Webhooks extends BaseWebhooks {
12850
+ }
12851
+
12852
+ export declare namespace Webhooks {
12853
+ 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, };
12854
+ }
12855
+
12856
+ declare interface WebhookUpdateParams {
12857
+ /**
12858
+ * Path param: Which version of the API to use.
12859
+ */
12860
+ api_version?: string;
12861
+ /**
12862
+ * Body param: Required. The events that the webhook is subscribed to. Available
12863
+ * events:
12864
+ *
12865
+ * - batch.succeeded
12866
+ * - batch.cancelled
12867
+ * - batch.expired
12868
+ * - batch.failed
12869
+ * - interaction.requires_action
12870
+ * - interaction.completed
12871
+ * - interaction.failed
12872
+ * - interaction.cancelled
12873
+ * - video.generated
12874
+ */
12875
+ subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12876
+ /**
12877
+ * Body param: Required. The URI to which webhook events will be sent.
12878
+ */
12879
+ uri: string;
12880
+ /**
12881
+ * Query param: Optional. The list of fields to update.
12882
+ */
12883
+ update_mask?: string;
12884
+ /**
12885
+ * Body param: Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12886
+ */
12887
+ name?: string;
12888
+ /**
12889
+ * Body param: The state of the webhook.
12890
+ */
12891
+ state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12892
+ }
12893
+
12894
+ /**
12895
+ * A Webhook resource.
12896
+ */
12897
+ declare interface WebhookUpdateResponse {
12898
+ /**
12899
+ * Required. The events that the webhook is subscribed to. Available events:
12900
+ *
12901
+ * - batch.succeeded
12902
+ * - batch.cancelled
12903
+ * - batch.expired
12904
+ * - batch.failed
12905
+ * - interaction.requires_action
12906
+ * - interaction.completed
12907
+ * - interaction.failed
12908
+ * - interaction.cancelled
12909
+ * - video.generated
12910
+ */
12911
+ subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12912
+ /**
12913
+ * Required. The URI to which webhook events will be sent.
12914
+ */
12915
+ uri: string;
12916
+ /**
12917
+ * Output only. The timestamp when the webhook was created.
12918
+ */
12919
+ create_time?: string;
12920
+ /**
12921
+ * Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12922
+ */
12923
+ name?: string;
12924
+ /**
12925
+ * Output only. The new signing secret for the webhook. Only populated on create.
12926
+ */
12927
+ new_signing_secret?: string;
12928
+ /**
12929
+ * Output only. The signing secrets associated with this webhook.
12930
+ */
12931
+ signing_secrets?: Array<WebhookUpdateResponse.SigningSecret>;
12932
+ /**
12933
+ * The state of the webhook.
12934
+ */
12935
+ state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12936
+ /**
12937
+ * Output only. The timestamp when the webhook was last updated.
12938
+ */
12939
+ update_time?: string;
12940
+ }
12941
+
12942
+ declare namespace WebhookUpdateResponse {
12943
+ /**
12944
+ * Represents a signing secret used to verify webhook payloads.
12945
+ */
12946
+ interface SigningSecret {
12947
+ /**
12948
+ * Output only. The expiration date of the signing secret.
12949
+ */
12950
+ expire_time?: string;
12951
+ /**
12952
+ * Output only. The truncated version of the signing secret.
12953
+ */
12954
+ truncated_secret?: string;
12955
+ }
12956
+ }
12957
+
12265
12958
  /** Standard web search for grounding and related configurations. Only text results are returned. */
12266
12959
  export declare interface WebSearch {
12267
12960
  }