@google/genai 1.22.0 → 1.24.0

package/dist/genai.d.ts

@@ -5,8 +5,7 @@ import { GoogleAuthOptions } from 'google-auth-library';
 /** Marks the end of user activity.
 
  This can only be sent if automatic (i.e. server-side) activity detection is
- disabled.
- */
+ disabled. */
 export declare interface ActivityEnd {
 }
 
@@ -29,8 +28,7 @@ export declare enum ActivityHandling {
 /** Marks the start of user activity.
 
  This can only be sent if automatic (i.e. server-side) activity detection is
- disabled.
- */
+ disabled. */
 export declare interface ActivityStart {
 }
 
@@ -1153,8 +1151,7 @@ export declare type ContentListUnion = Content | Content[] | PartUnion | PartUni
 
  A content reference image represents a subject to reference (ex. person,
  product, animal) provided by the user. It can optionally be provided in
- addition to a style reference image (ex. background, style reference).
- */
+ addition to a style reference image (ex. background, style reference). */
 export declare class ContentReferenceImage {
     /** The reference image for the editing operation. */
     referenceImage?: Image_2;
@@ -1194,8 +1191,7 @@ export declare interface ControlReferenceConfig {
  enable_control_image_computation field in the config should be set to True.
 
  A control image is an image that represents a sketch image of areas for the
- model to fill in based on the prompt.
- */
+ model to fill in based on the prompt. */
 export declare class ControlReferenceImage {
     /** The reference image for the editing operation. */
     referenceImage?: Image_2;
@@ -1390,8 +1386,7 @@ export declare interface CreateCachedContentParameters {
 /** Parameters for initializing a new chat session.
 
  These parameters are used when creating a chat session with the
- `chats.create()` method.
- */
+ `chats.create()` method. */
 export declare interface CreateChatParameters {
     /** The name of the model to use for the chat session.
 
@@ -1475,6 +1470,16 @@ export declare class CreateFileResponse {
     sdkHttpResponse?: HttpResponse;
 }
 
+/**
+ * Creates a `FunctionResponsePart` object from a `base64` encoded `string`.
+ */
+export declare function createFunctionResponsePartFromBase64(data: string, mimeType: string): FunctionResponsePart;
+
+/**
+ * Creates a `FunctionResponsePart` object from a `URI` string.
+ */
+export declare function createFunctionResponsePartFromUri(uri: string, mimeType: string): FunctionResponsePart;
+
 /**
  * Creates a `Content` object with a model role from a `PartListUnion` object or `string`.
  */
@@ -1503,7 +1508,7 @@ export declare function createPartFromFunctionCall(name: string, args: Record<st
 /**
  * Creates a `Part` object from a `FunctionResponse` object.
  */
-export declare function createPartFromFunctionResponse(id: string, name: string, response: Record<string, unknown>): Part;
+export declare function createPartFromFunctionResponse(id: string, name: string, response: Record<string, unknown>, parts?: FunctionResponsePart[]): Part;
 
 /**
  * Creates a `Part` object from a `text` string.
@@ -1849,6 +1854,8 @@ export declare interface EditImageConfig {
     outputCompressionQuality?: number;
     /** Whether to add a watermark to the generated images. */
     addWatermark?: boolean;
+    /** User specified labels to track billing usage. */
+    labels?: Record<string, string>;
     /** Describes the editing mode for the request. */
     editMode?: EditMode;
     /** The number of sampling steps. A higher value has better image
@@ -2302,8 +2309,7 @@ export declare interface FileStatus {
 
 /** Output only. The reason why the model stopped generating tokens.
 
- If empty, the model has not stopped generating the tokens.
- */
+ If empty, the model has not stopped generating the tokens. */
 export declare enum FinishReason {
     /**
      * The finish reason is unspecified.
@@ -2360,7 +2366,11 @@ export declare enum FinishReason {
     /**
      * Image generation stopped because the generated images have prohibited content.
      */
-    IMAGE_PROHIBITED_CONTENT = "IMAGE_PROHIBITED_CONTENT"
+    IMAGE_PROHIBITED_CONTENT = "IMAGE_PROHIBITED_CONTENT",
+    /**
+     * The model was expected to generate an image, but none was generated.
+     */
+    NO_IMAGE = "NO_IMAGE"
 }
 
 /** A function call. */
@@ -2409,8 +2419,7 @@ export declare enum FunctionCallingConfigMode {
 /** Defines a function that the model can generate JSON inputs for.
 
  The inputs are based on `OpenAPI 3.0 specifications
- <https://spec.openapis.org/oas/v3.0.3>`_.
- */
+ <https://spec.openapis.org/oas/v3.0.3>`_. */
 export declare interface FunctionDeclaration {
     /** Defines the function behavior. */
     behavior?: Behavior;
@@ -2448,8 +2457,7 @@ export declare class FunctionResponse {
 /** Raw media bytes for function response.
 
  Text should not be sent as raw bytes, use the FunctionResponse.response
- field.
- */
+ field. */
 export declare class FunctionResponseBlob {
     /** Required. The IANA standard MIME type of the source data. */
     mimeType?: string;
@@ -2474,8 +2482,7 @@ export declare class FunctionResponseFileData {
 
  A `FunctionResponsePart` must have a fixed IANA MIME type identifying the
  type and subtype of the media if the `inline_data` field is filled with raw
- bytes.
- */
+ bytes. */
 export declare class FunctionResponsePart {
     /** Optional. Inline media bytes. */
     inlineData?: FunctionResponseBlob;
@@ -2522,8 +2529,7 @@ export declare interface GeminiPreferenceExampleCompletion {
 /** Optional model configuration parameters.
 
  For more information, see `Content generation parameters
- <https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/content-generation-parameters>`_.
- */
+ <https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/content-generation-parameters>`_. */
 export declare interface GenerateContentConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
@@ -2945,6 +2951,8 @@ export declare interface GenerateImagesConfig {
     outputCompressionQuality?: number;
     /** Whether to add a watermark to the generated images. */
     addWatermark?: boolean;
+    /** User specified labels to track billing usage. */
+    labels?: Record<string, string>;
     /** The size of the largest dimension of the generated image.
      Supported sizes are 1K and 2K (not supported for Imagen 3 models). */
     imageSize?: string;
@@ -3415,6 +3423,8 @@ export declare interface GoogleGenAIOptions {
 export declare interface GoogleMaps {
     /** Optional. Auth config for the Google Maps tool. */
     authConfig?: AuthConfig;
+    /** Optional. If true, include the widget context token in the response. */
+    enableWidget?: boolean;
 }
 
 /** The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */
@@ -3508,6 +3518,10 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
     relativePublishTimeDescription?: string;
     /** A reference representing this place review which may be used to look up this place review again. */
     review?: string;
+    /** Id of the review referencing the place. */
+    reviewId?: string;
+    /** Title of the review. */
+    title?: string;
 }
 
 /** Chunk from context retrieved by the retrieval tools. */
@@ -3548,10 +3562,20 @@ export declare interface GroundingMetadata {
     retrievalQueries?: string[];
     /** Optional. Google search entry for the following-up web searches. */
     searchEntryPoint?: SearchEntryPoint;
+    /** Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. */
+    sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
     /** Optional. Web search queries for the following-up web search. */
     webSearchQueries?: string[];
 }
 
+/** Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. */
+export declare interface GroundingMetadataSourceFlaggingUri {
+    /** A link where users can flag a problem with the source (place or review). */
+    flagContentUri?: string;
+    /** Id of the place or review. */
+    sourceId?: string;
+}
+
 /** Grounding support. */
 export declare interface GroundingSupport {
     /** Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. */
@@ -3851,6 +3875,8 @@ export declare interface InlinedRequest {
     /** Content of the request.
      */
     contents?: ContentListUnion;
+    /** The metadata to be associated with the request. */
+    metadata?: Record<string, string>;
     /** Configuration that contains optional model parameters.
      */
     config?: GenerateContentConfig;
@@ -3871,8 +3897,7 @@ export declare class InlinedResponse {
  The start time must be less than or equal to the end time.
  When the start equals the end time, the interval is an empty interval.
  (matches no time)
- When both start and end are unspecified, the interval matches any time.
- */
+ When both start and end are unspecified, the interval matches any time. */
 export declare interface Interval {
     /** The start time of the interval. */
     startTime?: string;
@@ -3959,8 +3984,7 @@ export declare enum Language {
  This is expressed as a pair of doubles to represent degrees latitude and
  degrees longitude. Unless specified otherwise, this object must conform to the
  <a href="https://en.wikipedia.org/wiki/World_Geodetic_System#1984_version">
- WGS84 standard</a>. Values must be within normalized ranges.
- */
+ WGS84 standard</a>. Values must be within normalized ranges. */
 export declare interface LatLng {
     /** The latitude in degrees. It must be in the range [-90.0, +90.0]. */
     latitude?: number;
@@ -4201,8 +4225,7 @@ export declare interface LiveCallbacks {
  All the content here will unconditionally be appended to the conversation
  history and used as part of the prompt to the model to generate content.
 
- A message here will interrupt any current model generation.
- */
+ A message here will interrupt any current model generation. */
 export declare interface LiveClientContent {
     /** The content appended to the current conversation with the model.
 
@@ -4242,8 +4265,7 @@ export declare interface LiveClientMessage {
  - Even before the end of turn, the data is processed incrementally
  to optimize for a fast start of the response from the model.
  - Is always assumed to be the user's input (cannot be used to populate
- conversation history).
- */
+ conversation history). */
 export declare interface LiveClientRealtimeInput {
     /** Inlined bytes data for media input. */
     mediaChunks?: Blob_2[];
@@ -4320,8 +4342,7 @@ export declare interface LiveClientSetup {
  Note that in the unary and server-streaming GenerateContent APIs function
  calling happens by exchanging the `Content` parts, while in the bidi
  GenerateContent APIs function calling happens over this dedicated set of
- messages.
- */
+ messages. */
 export declare class LiveClientToolResponse {
     /** The response to the function calls. */
     functionResponses?: FunctionResponse[];
@@ -4601,8 +4622,7 @@ export declare enum LiveMusicPlaybackControl {
 /** Server update generated by the model in response to client messages.
 
  Content is generated as quickly as possible, and not in real time.
- Clients may choose to buffer and play it out in real time.
- */
+ Clients may choose to buffer and play it out in real time. */
 export declare interface LiveMusicServerContent {
     /** The audio chunks that the model has generated. */
     audioChunks?: AudioChunk[];
@@ -4764,8 +4784,7 @@ export declare class LiveSendToolResponseParameters {
 /** Incremental server update generated by the model in response to client messages.
 
  Content is generated as quickly as possible, and not in real time. Clients
- may choose to buffer and play it out in real time.
- */
+ may choose to buffer and play it out in real time. */
 export declare interface LiveServerContent {
     /** The content that the model has generated as part of the current conversation with the user. */
     modelTurn?: Content;
@@ -4846,8 +4865,7 @@ export declare class LiveServerMessage {
 
 /** Update of the session resumption state.
 
- Only sent if `session_resumption` was set in the connection config.
- */
+ Only sent if `session_resumption` was set in the connection config. */
 export declare interface LiveServerSessionResumptionUpdate {
     /** New handle that represents state that can be resumed. Empty if `resumable`=false. */
     newHandle?: string;
@@ -4877,8 +4895,7 @@ export declare interface LiveServerToolCall {
 
  If there were side-effects to those tool calls, clients may attempt to undo
  the tool calls. This message occurs only in cases where the clients interrupt
- server turns.
- */
+ server turns. */
 export declare interface LiveServerToolCallCancellation {
     /** The ids of the tool calls to be cancelled. */
     ids?: string[];
@@ -4929,8 +4946,7 @@ export declare interface MaskReferenceConfig {
 
  A mask image is an image whose non-zero values indicate where to edit the base
  image. If the user provides a mask image, the mask must be in the same
- dimensions as the raw image.
- */
+ dimensions as the raw image. */
 export declare class MaskReferenceImage {
     /** The reference image for the editing operation. */
     referenceImage?: Image_2;
@@ -5694,8 +5710,7 @@ export declare class Pager<T> implements AsyncIterable<T> {
 
  Exactly one field within a Part should be set, representing the specific type
  of content being conveyed. Using multiple fields within the same `Part`
- instance is considered invalid.
- */
+ instance is considered invalid. */
 export declare interface Part {
     /** Metadata for a given video. */
     videoMetadata?: VideoMetadata;
@@ -5870,8 +5885,7 @@ export declare interface RagRetrievalConfigRankingRankService {
 
  A raw reference image represents the base image to edit, provided by the user.
  It can optionally be provided in addition to a mask reference image or
- a style reference image.
- */
+ a style reference image. */
 export declare class RawReferenceImage {
     /** The reference image for the editing operation. */
     referenceImage?: Image_2;
@@ -5886,8 +5900,7 @@ export declare class RawReferenceImage {
 /** Marks the end of user activity.
 
  This can only be sent if automatic (i.e. server-side) activity detection is
- disabled.
- */
+ disabled. */
 export declare interface RealtimeInputConfig {
     /** If not set, automatic activity detection is enabled by default. If automatic voice detection is disabled, the client must send activity signals. */
     automaticActivityDetection?: AutomaticActivityDetection;
@@ -5931,6 +5944,8 @@ export declare interface RecontextImageConfig {
     outputCompressionQuality?: number;
     /** Whether to use the prompt rewriting logic. */
     enhancePrompt?: boolean;
+    /** User specified labels to track billing usage. */
+    labels?: Record<string, string>;
 }
 
 /** The parameters for recontextualizing an image. */
@@ -6144,8 +6159,7 @@ export declare enum Scale {
 
  Represents a select subset of an [OpenAPI 3.0 schema
  object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may
- be added in the future as needed.
- */
+ be added in the future as needed. */
 export declare interface Schema {
     /** Optional. The value should be validated against any (one or more) of the subschemas in the list. */
     anyOf?: Schema[];
@@ -6250,6 +6264,8 @@ export declare interface SegmentImageConfig {
      can be set to a decimal value between 0 and 255 non-inclusive.
      Set to -1 for no binary color thresholding. */
     binaryColorThreshold?: number;
+    /** User specified labels to track billing usage. */
+    labels?: Record<string, string>;
 }
 
 /** The parameters for segmenting an image. */
@@ -6293,8 +6309,7 @@ export declare enum SegmentMode {
 
 /** Parameters for sending a message within a chat session.
 
- These parameters are used with the `chat.sendMessage()` method.
- */
+ These parameters are used with the `chat.sendMessage()` method. */
 export declare interface SendMessageParameters {
     /** The message to send to the model.
 
@@ -6440,8 +6455,7 @@ export declare class Session {
 /** Configuration of session resumption mechanism.
 
  Included in `LiveConnectConfig.session_resumption`. If included server
- will send `LiveServerSessionResumptionUpdate` messages.
- */
+ will send `LiveServerSessionResumptionUpdate` messages. */
 export declare interface SessionResumptionConfig {
     /** Session resumption handle of previous session (session to restore).
 
@@ -6488,8 +6502,7 @@ export declare class SingleEmbedContentResponse {
  Context window will always be cut at start of USER role turn. System
  instructions and `BidiGenerateContentSetup.prefix_turns` will not be
  subject to the sliding window mechanism, they will always stay at the
- beginning of context window.
- */
+ beginning of context window. */
 export declare interface SlidingWindow {
     /** Session reduction target -- how many tokens we should keep. Window shortening operation has some latency costs, so we should avoid running it on every turn. Should be < trigger_tokens. If not set, trigger_tokens/2 is assumed. */
     targetTokens?: string;
@@ -6549,8 +6562,7 @@ export declare interface StyleReferenceConfig {
  additionally optional config parameters for the style reference image.
 
  A raw reference image can also be provided as a destination for the style to
- be applied to.
- */
+ be applied to. */
 export declare class StyleReferenceImage {
     /** The reference image for the editing operation. */
     referenceImage?: Image_2;
@@ -6578,8 +6590,7 @@ export declare interface SubjectReferenceConfig {
  additionally optional config parameters for the subject reference image.
 
  A raw reference image can also be provided as a destination for the subject to
- be applied to.
- */
+ be applied to. */
 export declare class SubjectReferenceImage {
     /** The reference image for the editing operation. */
     referenceImage?: Image_2;
@@ -6857,8 +6868,7 @@ export declare interface ToolCodeExecution {
 
 /** Tool config.
 
- This config is shared for all tools provided in the request.
- */
+ This config is shared for all tools provided in the request. */
 export declare interface ToolConfig {
     /** Optional. Function calling config. */
     functionCallingConfig?: FunctionCallingConfig;
@@ -7191,6 +7201,8 @@ export declare enum Type {
 
 declare namespace types {
     export {
+        createFunctionResponsePartFromBase64,
+        createFunctionResponsePartFromUri,
         createPartFromUri,
         createPartFromText,
         createPartFromFunctionCall,
@@ -7335,6 +7347,7 @@ declare namespace types {
         GroundingSupport,
         RetrievalMetadata,
         SearchEntryPoint,
+        GroundingMetadataSourceFlaggingUri,
         GroundingMetadata,
         LogprobsResultCandidate,
         LogprobsResultTopCandidates,
@@ -7690,8 +7703,7 @@ export declare interface UploadFileParameters {
 
  For more information on this configuration, refer to
  the `Imagen API reference documentation
- <https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api>`_.
- */
+ <https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api>`_. */
 export declare interface UpscaleImageConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
@@ -7721,6 +7733,8 @@ export declare interface UpscaleImageConfig {
      output image will have be more different from the input image, but
      with finer details and less noise. */
     imagePreservationFactor?: number;
+    /** User specified labels to track billing usage. */
+    labels?: Record<string, string>;
 }
 
 /** User-facing config UpscaleImageParameters. */