// Copyright 2026 Google LLC

//

// Licensed under the Apache License, Version 2.0 (the "License");

// you may not use this file except in compliance with the License.

// You may obtain a copy of the License at

//

// http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing, software

// distributed under the License is distributed on an "AS IS" BASIS,

// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

// See the License for the specific language governing permissions and

// limitations under the License.

// Code generated by the Google Gen AI SDK generator DO NOT EDIT.

package genai

import (

"cloud.google.com/go/civil"

"encoding/json"

"fmt"

"log"

"net/http"

"reflect"

"strings"

"time"

)

// Programming language of the `code`.

type Language string

const (

// Unspecified language. This value should not be used.

LanguageUnspecified Language = "LANGUAGE_UNSPECIFIED"

// Python >= 3.10, with numpy and simpy available.

LanguagePython Language = "PYTHON"

)

// Outcome of the code execution.

type Outcome string

const (

// Unspecified status. This value should not be used.

OutcomeUnspecified Outcome = "OUTCOME_UNSPECIFIED"

// Code execution completed successfully.

OutcomeOK Outcome = "OUTCOME_OK"

// Code execution finished but with a failure. `stderr` should contain the reason.

OutcomeFailed Outcome = "OUTCOME_FAILED"

// Code execution ran for too long, and was cancelled. There may or may not be a partial

// output present.

OutcomeDeadlineExceeded Outcome = "OUTCOME_DEADLINE_EXCEEDED"

)

// Specifies how the response should be scheduled in the conversation.

type FunctionResponseScheduling string

const (

// This value is unused.

FunctionResponseSchedulingUnspecified FunctionResponseScheduling = "SCHEDULING_UNSPECIFIED"

// Only add the result to the conversation context, do not interrupt or trigger generation.

FunctionResponseSchedulingSilent FunctionResponseScheduling = "SILENT"

// Add the result to the conversation context, and prompt to generate output without

// interrupting ongoing generation.

FunctionResponseSchedulingWhenIdle FunctionResponseScheduling = "WHEN_IDLE"

// Add the result to the conversation context, interrupt ongoing generation and prompt

// to generate output.

FunctionResponseSchedulingInterrupt FunctionResponseScheduling = "INTERRUPT"

)

// Data type of the schema field.

type Type string

const (

// Not specified, should not be used.

TypeUnspecified Type = "TYPE_UNSPECIFIED"

// OpenAPI string type

TypeString Type = "STRING"

// OpenAPI number type

TypeNumber Type = "NUMBER"

// OpenAPI integer type

TypeInteger Type = "INTEGER"

// OpenAPI boolean type

TypeBoolean Type = "BOOLEAN"

// OpenAPI array type

TypeArray Type = "ARRAY"

// OpenAPI object type

TypeObject Type = "OBJECT"

// NULL type

TypeNULL Type = "NULL"

)

// The environment being operated.

type Environment string

const (

// Defaults to browser.

EnvironmentUnspecified Environment = "ENVIRONMENT_UNSPECIFIED"

// Operates in a web browser.

EnvironmentBrowser Environment = "ENVIRONMENT_BROWSER"

)

// Type of auth scheme. This enum is not supported in Gemini API.

type AuthType string

const (

AuthTypeUnspecified AuthType = "AUTH_TYPE_UNSPECIFIED"

// No Auth.

AuthTypeNoAuth AuthType = "NO_AUTH"

// API Key Auth.

AuthTypeAPIKeyAuth AuthType = "API_KEY_AUTH"

// HTTP Basic Auth.

AuthTypeHTTPBasicAuth AuthType = "HTTP_BASIC_AUTH"

// Google Service Account Auth.

AuthTypeGoogleServiceAccountAuth AuthType = "GOOGLE_SERVICE_ACCOUNT_AUTH"

// OAuth auth.

AuthTypeOauth AuthType = "OAUTH"

// OpenID Connect (OIDC) Auth.

AuthTypeOidcAuth AuthType = "OIDC_AUTH"

)

// The location of the API key. This enum is not supported in Gemini API.

type HTTPElementLocation string

const (

HTTPElementLocationHTTPInUnspecified HTTPElementLocation = "HTTP_IN_UNSPECIFIED"

// Element is in the HTTP request query.

HTTPElementLocationHTTPInQuery HTTPElementLocation = "HTTP_IN_QUERY"

// Element is in the HTTP request header.

HTTPElementLocationHTTPInHeader HTTPElementLocation = "HTTP_IN_HEADER"

// Element is in the HTTP request path.

HTTPElementLocationHTTPInPath HTTPElementLocation = "HTTP_IN_PATH"

// Element is in the HTTP request body.

HTTPElementLocationHTTPInBody HTTPElementLocation = "HTTP_IN_BODY"

// Element is in the HTTP request cookie.

HTTPElementLocationHTTPInCookie HTTPElementLocation = "HTTP_IN_COOKIE"

)

// The API spec that the external API implements. This enum is not supported in Gemini

// API.

type APISpec string

const (

// Unspecified API spec. This value should not be used.

APISpecUnspecified APISpec = "API_SPEC_UNSPECIFIED"

// Simple search API spec.

APISpecSimpleSearch APISpec = "SIMPLE_SEARCH"

// Elastic search API spec.

APISpecElasticSearch APISpec = "ELASTIC_SEARCH"

)

// Sites with confidence level chosen & above this value will be blocked from the search

// results. This enum is not supported in Gemini API.

type PhishBlockThreshold string

const (

// Defaults to unspecified.

PhishBlockThresholdUnspecified PhishBlockThreshold = "PHISH_BLOCK_THRESHOLD_UNSPECIFIED"

// Blocks Low and above confidence URL that is risky.

PhishBlockThresholdBlockLowAndAbove PhishBlockThreshold = "BLOCK_LOW_AND_ABOVE"

// Blocks Medium and above confidence URL that is risky.

PhishBlockThresholdBlockMediumAndAbove PhishBlockThreshold = "BLOCK_MEDIUM_AND_ABOVE"

// Blocks High and above confidence URL that is risky.

PhishBlockThresholdBlockHighAndAbove PhishBlockThreshold = "BLOCK_HIGH_AND_ABOVE"

// Blocks Higher and above confidence URL that is risky.

PhishBlockThresholdBlockHigherAndAbove PhishBlockThreshold = "BLOCK_HIGHER_AND_ABOVE"

// Blocks Very high and above confidence URL that is risky.

PhishBlockThresholdBlockVeryHighAndAbove PhishBlockThreshold = "BLOCK_VERY_HIGH_AND_ABOVE"

// Blocks Extremely high confidence URL that is risky.

PhishBlockThresholdBlockOnlyExtremelyHigh PhishBlockThreshold = "BLOCK_ONLY_EXTREMELY_HIGH"

)

// Specifies the function Behavior. Currently only supported by the BidiGenerateContent

// method. This enum is not supported in Vertex AI.

type Behavior string

const (

// This value is unused.

BehaviorUnspecified Behavior = "UNSPECIFIED"

// If set, the system will wait to receive the function response before continuing the

// conversation.

BehaviorBlocking Behavior = "BLOCKING"

// If set, the system will not wait to receive the function response. Instead, it will

// attempt to handle function responses as they become available while maintaining the

// conversation between the user and the model.

BehaviorNonBlocking Behavior = "NON_BLOCKING"

)

// The mode of the predictor to be used in dynamic retrieval.

type DynamicRetrievalConfigMode string

const (

// Always trigger retrieval.

DynamicRetrievalConfigModeUnspecified DynamicRetrievalConfigMode = "MODE_UNSPECIFIED"

// Run retrieval only when system decides it is necessary.

DynamicRetrievalConfigModeDynamic DynamicRetrievalConfigMode = "MODE_DYNAMIC"

)

// Function calling mode.

type FunctionCallingConfigMode string

const (

// Unspecified function calling mode. This value should not be used.

FunctionCallingConfigModeUnspecified FunctionCallingConfigMode = "MODE_UNSPECIFIED"

// Default model behavior, model decides to predict either function calls or natural

// language response.

FunctionCallingConfigModeAuto FunctionCallingConfigMode = "AUTO"

// Model is constrained to always predicting function calls only. If "allowed_function_names"

// are set, the predicted function calls will be limited to any one of "allowed_function_names",

// else the predicted function calls will be any one of the provided "function_declarations".

FunctionCallingConfigModeAny FunctionCallingConfigMode = "ANY"

// Model will not predict any function calls. Model behavior is same as when not passing

// any function declarations.

FunctionCallingConfigModeNone FunctionCallingConfigMode = "NONE"

// Model is constrained to predict either function calls or natural language response.

// If "allowed_function_names" are set, the predicted function calls will be limited

// to any one of "allowed_function_names", else the predicted function calls will be

// any one of the provided "function_declarations".

FunctionCallingConfigModeValidated FunctionCallingConfigMode = "VALIDATED"

)

// The number of thoughts tokens that the model should generate.

type ThinkingLevel string

const (

// Unspecified thinking level.

ThinkingLevelUnspecified ThinkingLevel = "THINKING_LEVEL_UNSPECIFIED"

// MINIMAL thinking level.

ThinkingLevelMinimal ThinkingLevel = "MINIMAL"

// Low thinking level.

ThinkingLevelLow ThinkingLevel = "LOW"

// Medium thinking level.

ThinkingLevelMedium ThinkingLevel = "MEDIUM"

// High thinking level.

ThinkingLevelHigh ThinkingLevel = "HIGH"

)

// Enum that controls the generation of people.

type PersonGeneration string

const (

// Block generation of images of people.

PersonGenerationDontAllow PersonGeneration = "DONT_ALLOW"

// Generate images of adults, but not children.

PersonGenerationAllowAdult PersonGeneration = "ALLOW_ADULT"

// Generate images that include adults and children.

PersonGenerationAllowAll PersonGeneration = "ALLOW_ALL"

)

// Controls whether prominent people (celebrities) generation is allowed. If used with

// personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE

// is set, all person generation would be blocked. If this field is unspecified, the

// default behavior is to allow prominent people. This enum is not supported in Gemini

// API.

type ProminentPeople string

const (

// Unspecified value. The model will proceed with the default behavior, which is to

// allow generation of prominent people.

ProminentPeopleUnspecified ProminentPeople = "PROMINENT_PEOPLE_UNSPECIFIED"

// Allows the model to generate images of prominent people.

ProminentPeopleAllowProminentPeople ProminentPeople = "ALLOW_PROMINENT_PEOPLE"

// Prevents the model from generating images of prominent people.

ProminentPeopleBlockProminentPeople ProminentPeople = "BLOCK_PROMINENT_PEOPLE"

)

// The harm category to be blocked.

type HarmCategory string

const (

// Default value. This value is unused.

HarmCategoryUnspecified HarmCategory = "HARM_CATEGORY_UNSPECIFIED"

// Abusive, threatening, or content intended to bully, torment, or ridicule.

HarmCategoryHarassment HarmCategory = "HARM_CATEGORY_HARASSMENT"

// Content that promotes violence or incites hatred against individuals or groups based

// on certain attributes.

HarmCategoryHateSpeech HarmCategory = "HARM_CATEGORY_HATE_SPEECH"

// Content that contains sexually explicit material.

HarmCategorySexuallyExplicit HarmCategory = "HARM_CATEGORY_SEXUALLY_EXPLICIT"

// Content that promotes, facilitates, or enables dangerous activities.

HarmCategoryDangerousContent HarmCategory = "HARM_CATEGORY_DANGEROUS_CONTENT"

// Deprecated: Election filter is not longer supported. The harm category is civic integrity.

HarmCategoryCivicIntegrity HarmCategory = "HARM_CATEGORY_CIVIC_INTEGRITY"

// Images that contain hate speech. This enum value is not supported in Gemini API.

HarmCategoryImageHate HarmCategory = "HARM_CATEGORY_IMAGE_HATE"

// Images that contain dangerous content. This enum value is not supported in Gemini

// API.

HarmCategoryImageDangerousContent HarmCategory = "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT"

// Images that contain harassment. This enum value is not supported in Gemini API.

HarmCategoryImageHarassment HarmCategory = "HARM_CATEGORY_IMAGE_HARASSMENT"

// Images that contain sexually explicit content. This enum value is not supported in

// Gemini API.

HarmCategoryImageSexuallyExplicit HarmCategory = "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT"

// Prompts designed to bypass safety filters. This enum value is not supported in Gemini

// API.

HarmCategoryJailbreak HarmCategory = "HARM_CATEGORY_JAILBREAK"

)

// The method for blocking content. If not specified, the default behavior is to use

// the probability score. This enum is not supported in Gemini API.

type HarmBlockMethod string

const (

// The harm block method is unspecified.

HarmBlockMethodUnspecified HarmBlockMethod = "HARM_BLOCK_METHOD_UNSPECIFIED"

// The harm block method uses both probability and severity scores.

HarmBlockMethodSeverity HarmBlockMethod = "SEVERITY"

// The harm block method uses the probability score.

HarmBlockMethodProbability HarmBlockMethod = "PROBABILITY"

)

// The threshold for blocking content. If the harm probability exceeds this threshold,

// the content will be blocked.

type HarmBlockThreshold string

const (

// The harm block threshold is unspecified.

HarmBlockThresholdUnspecified HarmBlockThreshold = "HARM_BLOCK_THRESHOLD_UNSPECIFIED"

// Block content with a low harm probability or higher.

HarmBlockThresholdBlockLowAndAbove HarmBlockThreshold = "BLOCK_LOW_AND_ABOVE"

// Block content with a medium harm probability or higher.

HarmBlockThresholdBlockMediumAndAbove HarmBlockThreshold = "BLOCK_MEDIUM_AND_ABOVE"

// Block content with a high harm probability.

HarmBlockThresholdBlockOnlyHigh HarmBlockThreshold = "BLOCK_ONLY_HIGH"

// Do not block any content, regardless of its harm probability.

HarmBlockThresholdBlockNone HarmBlockThreshold = "BLOCK_NONE"

// Turn off the safety filter entirely.

HarmBlockThresholdOff HarmBlockThreshold = "OFF"

)

// The reason why the model stopped generating tokens.

// If empty, the model has not stopped generating the tokens.

type FinishReason string

const (

// The finish reason is unspecified.

FinishReasonUnspecified FinishReason = "FINISH_REASON_UNSPECIFIED"

// Token generation reached a natural stopping point or a configured stop sequence.

FinishReasonStop FinishReason = "STOP"

// Token generation reached the configured maximum output tokens.

FinishReasonMaxTokens FinishReason = "MAX_TOKENS"

// Token generation stopped because the content potentially contains safety violations.

// NOTE: When streaming, [content][] is empty if content filters blocks the output.

FinishReasonSafety FinishReason = "SAFETY"

// The token generation stopped because of potential recitation.

FinishReasonRecitation FinishReason = "RECITATION"

// The token generation stopped because of using an unsupported language.

FinishReasonLanguage FinishReason = "LANGUAGE"

// All other reasons that stopped the token generation.

FinishReasonOther FinishReason = "OTHER"

// Token generation stopped because the content contains forbidden terms.

FinishReasonBlocklist FinishReason = "BLOCKLIST"

// Token generation stopped for potentially containing prohibited content.

FinishReasonProhibitedContent FinishReason = "PROHIBITED_CONTENT"

// Token generation stopped because the content potentially contains Sensitive Personally

// Identifiable Information (SPII).

FinishReasonSPII FinishReason = "SPII"

// The function call generated by the model is invalid.

FinishReasonMalformedFunctionCall FinishReason = "MALFORMED_FUNCTION_CALL"

// Token generation stopped because generated images have safety violations.

FinishReasonImageSafety FinishReason = "IMAGE_SAFETY"

// The tool call generated by the model is invalid.

FinishReasonUnexpectedToolCall FinishReason = "UNEXPECTED_TOOL_CALL"

// Image generation stopped because the generated images have prohibited content.

FinishReasonImageProhibitedContent FinishReason = "IMAGE_PROHIBITED_CONTENT"

// The model was expected to generate an image, but none was generated.

FinishReasonNoImage FinishReason = "NO_IMAGE"

// Image generation stopped because the generated image may be a recitation from a source.

FinishReasonImageRecitation FinishReason = "IMAGE_RECITATION"

// Image generation stopped for a reason not otherwise specified.

FinishReasonImageOther FinishReason = "IMAGE_OTHER"

)

// The probability of harm for this category.

type HarmProbability string

const (

// The harm probability is unspecified.

HarmProbabilityUnspecified HarmProbability = "HARM_PROBABILITY_UNSPECIFIED"

// The harm probability is negligible.

HarmProbabilityNegligible HarmProbability = "NEGLIGIBLE"

// The harm probability is low.

HarmProbabilityLow HarmProbability = "LOW"

// The harm probability is medium.

HarmProbabilityMedium HarmProbability = "MEDIUM"

// The harm probability is high.

HarmProbabilityHigh HarmProbability = "HIGH"

)

// The severity of harm for this category. This enum is not supported in Gemini API.

type HarmSeverity string

const (

// The harm severity is unspecified.

HarmSeverityUnspecified HarmSeverity = "HARM_SEVERITY_UNSPECIFIED"

// The harm severity is negligible.

HarmSeverityNegligible HarmSeverity = "HARM_SEVERITY_NEGLIGIBLE"

// The harm severity is low.

HarmSeverityLow HarmSeverity = "HARM_SEVERITY_LOW"

// The harm severity is medium.

HarmSeverityMedium HarmSeverity = "HARM_SEVERITY_MEDIUM"

// The harm severity is high.

HarmSeverityHigh HarmSeverity = "HARM_SEVERITY_HIGH"

)

// The status of the URL retrieval.

type URLRetrievalStatus string

const (

// Default value. This value is unused.

URLRetrievalStatusUnspecified URLRetrievalStatus = "URL_RETRIEVAL_STATUS_UNSPECIFIED"

// The URL was retrieved successfully.

URLRetrievalStatusSuccess URLRetrievalStatus = "URL_RETRIEVAL_STATUS_SUCCESS"

// The URL retrieval failed.

URLRetrievalStatusError URLRetrievalStatus = "URL_RETRIEVAL_STATUS_ERROR"

// URL retrieval is failed because the content is behind paywall. This enum value is

// not supported in Vertex AI.

URLRetrievalStatusPaywall URLRetrievalStatus = "URL_RETRIEVAL_STATUS_PAYWALL"

// URL retrieval is failed because the content is unsafe. This enum value is not supported

// in Vertex AI.

URLRetrievalStatusUnsafe URLRetrievalStatus = "URL_RETRIEVAL_STATUS_UNSAFE"

)

// The reason why the prompt was blocked.

type BlockedReason string

const (

// The blocked reason is unspecified.

BlockedReasonUnspecified BlockedReason = "BLOCKED_REASON_UNSPECIFIED"

// The prompt was blocked for safety reasons.

BlockedReasonSafety BlockedReason = "SAFETY"

// The prompt was blocked for other reasons. For example, it may be due to the prompt's

// language, or because it contains other harmful content.

BlockedReasonOther BlockedReason = "OTHER"

// The prompt was blocked because it contains a term from the terminology blocklist.

BlockedReasonBlocklist BlockedReason = "BLOCKLIST"

// The prompt was blocked because it contains prohibited content.

BlockedReasonProhibitedContent BlockedReason = "PROHIBITED_CONTENT"

// The prompt was blocked because it contains content that is unsafe for image generation.

BlockedReasonImageSafety BlockedReason = "IMAGE_SAFETY"

// The prompt was blocked by Model Armor. This enum value is not supported in Gemini

// API.

BlockedReasonModelArmor BlockedReason = "MODEL_ARMOR"

// The prompt was blocked as a jailbreak attempt. This enum value is not supported in

// Gemini API.

BlockedReasonJailbreak BlockedReason = "JAILBREAK"

)

// The traffic type for this request. This enum is not supported in Gemini API.

type TrafficType string

const (

// Unspecified request traffic type.

TrafficTypeUnspecified TrafficType = "TRAFFIC_TYPE_UNSPECIFIED"

// The request was processed using Pay-As-You-Go quota.

TrafficTypeOnDemand TrafficType = "ON_DEMAND"

// Type for Priority Pay-As-You-Go traffic.

TrafficTypeOnDemandPriority TrafficType = "ON_DEMAND_PRIORITY"

// Type for Flex traffic.

TrafficTypeOnDemandFlex TrafficType = "ON_DEMAND_FLEX"

// Type for Provisioned Throughput traffic.

TrafficTypeProvisionedThroughput TrafficType = "PROVISIONED_THROUGHPUT"

)

// Server content modalities.

type Modality string

const (

// The modality is unspecified.

ModalityUnspecified Modality = "MODALITY_UNSPECIFIED"

// Indicates the model should return text

ModalityText Modality = "TEXT"

// Indicates the model should return images.

ModalityImage Modality = "IMAGE"

// Indicates the model should return audio.

ModalityAudio Modality = "AUDIO"

// Indicates the model should return video.

ModalityVideo Modality = "VIDEO"

)

// The stage of the underlying model. This enum is not supported in Vertex AI.

type ModelStage string

const (

// Unspecified model stage.

ModelStageUnspecified ModelStage = "MODEL_STAGE_UNSPECIFIED"

// The underlying model is subject to lots of tunings.

ModelStageUnstableExperimental ModelStage = "UNSTABLE_EXPERIMENTAL"

// Models in this stage are for experimental purposes only.

ModelStageExperimental ModelStage = "EXPERIMENTAL"

// Models in this stage are more mature than experimental models.

ModelStagePreview ModelStage = "PREVIEW"

// Models in this stage are considered stable and ready for production use.

ModelStageStable ModelStage = "STABLE"

// If the model is on this stage, it means that this model is on the path to deprecation

// in near future. Only existing customers can use this model.

ModelStageLegacy ModelStage = "LEGACY"

// Models in this stage are deprecated. These models cannot be used.

ModelStageDeprecated ModelStage = "DEPRECATED"

// Models in this stage are retired. These models cannot be used.

ModelStageRetired ModelStage = "RETIRED"

)

// The media resolution to use.

type MediaResolution string

const (

// Media resolution has not been set

MediaResolutionUnspecified MediaResolution = "MEDIA_RESOLUTION_UNSPECIFIED"

// Media resolution set to low (64 tokens).

MediaResolutionLow MediaResolution = "MEDIA_RESOLUTION_LOW"

// Media resolution set to medium (256 tokens).

MediaResolutionMedium MediaResolution = "MEDIA_RESOLUTION_MEDIUM"

// Media resolution set to high (zoomed reframing with 256 tokens).

MediaResolutionHigh MediaResolution = "MEDIA_RESOLUTION_HIGH"

)

// Tuning mode. This enum is not supported in Gemini API.

type TuningMode string

const (

// Tuning mode is unspecified.

TuningModeUnspecified TuningMode = "TUNING_MODE_UNSPECIFIED"

// Full fine-tuning mode.

TuningModeFull TuningMode = "TUNING_MODE_FULL"

// PEFT adapter tuning mode.

TuningModePeftAdapter TuningMode = "TUNING_MODE_PEFT_ADAPTER"

)

// Adapter size for tuning. This enum is not supported in Gemini API.

type AdapterSize string

const (

// Adapter size is unspecified.

AdapterSizeUnspecified AdapterSize = "ADAPTER_SIZE_UNSPECIFIED"

// Adapter size 1.

AdapterSizeOne AdapterSize = "ADAPTER_SIZE_ONE"

// Adapter size 2.

AdapterSizeTwo AdapterSize = "ADAPTER_SIZE_TWO"

// Adapter size 4.

AdapterSizeFour AdapterSize = "ADAPTER_SIZE_FOUR"

// Adapter size 8.

AdapterSizeEight AdapterSize = "ADAPTER_SIZE_EIGHT"

// Adapter size 16.

AdapterSizeSixteen AdapterSize = "ADAPTER_SIZE_SIXTEEN"

// Adapter size 32.

AdapterSizeThirtyTwo AdapterSize = "ADAPTER_SIZE_THIRTY_TWO"

)

// Job state.

type JobState string

const (

// The job state is unspecified.

JobStateUnspecified JobState = "JOB_STATE_UNSPECIFIED"

// The job has been just created or resumed and processing has not yet begun.

JobStateQueued JobState = "JOB_STATE_QUEUED"

// The service is preparing to run the job.

JobStatePending JobState = "JOB_STATE_PENDING"

// The job is in progress.

JobStateRunning JobState = "JOB_STATE_RUNNING"

// The job completed successfully.

JobStateSucceeded JobState = "JOB_STATE_SUCCEEDED"

// The job failed.

JobStateFailed JobState = "JOB_STATE_FAILED"

// The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`,

// `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.

JobStateCancelling JobState = "JOB_STATE_CANCELLING"

// The job has been cancelled.

JobStateCancelled JobState = "JOB_STATE_CANCELLED"

// The job has been stopped, and can be resumed.

JobStatePaused JobState = "JOB_STATE_PAUSED"

// The job has expired.

JobStateExpired JobState = "JOB_STATE_EXPIRED"

// The job is being updated. Only jobs in the `JOB_STATE_RUNNING` state can be updated.

// After updating, the job goes back to the `JOB_STATE_RUNNING` state.

JobStateUpdating JobState = "JOB_STATE_UPDATING"

// The job is partially succeeded, some results may be missing due to errors.

JobStatePartiallySucceeded JobState = "JOB_STATE_PARTIALLY_SUCCEEDED"

)

// The detail state of the tuning job (while the overall `JobState` is running). This

// enum is not supported in Gemini API.

type TuningJobState string

const (

// Default tuning job state.

TuningJobStateUnspecified TuningJobState = "TUNING_JOB_STATE_UNSPECIFIED"

// Tuning job is waiting for job quota.

TuningJobStateWaitingForQuota TuningJobState = "TUNING_JOB_STATE_WAITING_FOR_QUOTA"

// Tuning job is validating the dataset.

TuningJobStateProcessingDataset TuningJobState = "TUNING_JOB_STATE_PROCESSING_DATASET"

// Tuning job is waiting for hardware capacity.

TuningJobStateWaitingForCapacity TuningJobState = "TUNING_JOB_STATE_WAITING_FOR_CAPACITY"

// Tuning job is running.

TuningJobStateTuning TuningJobState = "TUNING_JOB_STATE_TUNING"

// Tuning job is doing some post processing steps.

TuningJobStatePostProcessing TuningJobState = "TUNING_JOB_STATE_POST_PROCESSING"

)

// Aggregation metric. This enum is not supported in Gemini API.

type AggregationMetric string

const (

// Unspecified aggregation metric.

AggregationMetricUnspecified AggregationMetric = "AGGREGATION_METRIC_UNSPECIFIED"

// Average aggregation metric. Not supported for Pairwise metric.

AggregationMetricAverage AggregationMetric = "AVERAGE"

// Mode aggregation metric.

AggregationMetricMode AggregationMetric = "MODE"

// Standard deviation aggregation metric. Not supported for pairwise metric.

AggregationMetricStandardDeviation AggregationMetric = "STANDARD_DEVIATION"

// Variance aggregation metric. Not supported for pairwise metric.

AggregationMetricVariance AggregationMetric = "VARIANCE"

// Minimum aggregation metric. Not supported for pairwise metric.

AggregationMetricMinimum AggregationMetric = "MINIMUM"

// Maximum aggregation metric. Not supported for pairwise metric.

AggregationMetricMaximum AggregationMetric = "MAXIMUM"

// Median aggregation metric. Not supported for pairwise metric.

AggregationMetricMedian AggregationMetric = "MEDIAN"

// 90th percentile aggregation metric. Not supported for pairwise metric.

AggregationMetricPercentileP90 AggregationMetric = "PERCENTILE_P90"

// 95th percentile aggregation metric. Not supported for pairwise metric.

AggregationMetricPercentileP95 AggregationMetric = "PERCENTILE_P95"

// 99th percentile aggregation metric. Not supported for pairwise metric.

AggregationMetricPercentileP99 AggregationMetric = "PERCENTILE_P99"

)

// Pairwise metric choice. This enum is not supported in Gemini API.

type PairwiseChoice string

const (

// Unspecified prediction choice.

PairwiseChoiceUnspecified PairwiseChoice = "PAIRWISE_CHOICE_UNSPECIFIED"

// Baseline prediction wins

PairwiseChoiceBaseline PairwiseChoice = "BASELINE"

// Candidate prediction wins

PairwiseChoiceCandidate PairwiseChoice = "CANDIDATE"

// Winner cannot be determined

PairwiseChoiceTie PairwiseChoice = "TIE"

)

// The tuning task. Either I2V or T2V. This enum is not supported in Gemini API.

type TuningTask string

const (

// Default value. This value is unused.

TuningTaskUnspecified TuningTask = "TUNING_TASK_UNSPECIFIED"

// Tuning task for image to video.

TuningTaskI2v TuningTask = "TUNING_TASK_I2V"

// Tuning task for text to video.

TuningTaskT2v TuningTask = "TUNING_TASK_T2V"

// Tuning task for reference to video.

TuningTaskR2v TuningTask = "TUNING_TASK_R2V"

)

// Current state of the `Document`. This enum is not supported in Vertex AI.

type DocumentState string

const (

// The default value. This value is used if the state is omitted.

DocumentStateUnspecified DocumentState = "STATE_UNSPECIFIED"

// Some `Chunks` of the `Document` are being processed (embedding and vector storage).

DocumentStatePending DocumentState = "STATE_PENDING"

// All `Chunks` of the `Document` is processed and available for querying.

DocumentStateActive DocumentState = "STATE_ACTIVE"

// Some `Chunks` of the `Document` failed processing.

DocumentStateFailed DocumentState = "STATE_FAILED"

)

// The tokenization quality used for given media.

type PartMediaResolutionLevel string

const (

// Media resolution has not been set.

PartMediaResolutionLevelMediaResolutionUnspecified PartMediaResolutionLevel = "MEDIA_RESOLUTION_UNSPECIFIED"

// Media resolution set to low.

PartMediaResolutionLevelMediaResolutionLow PartMediaResolutionLevel = "MEDIA_RESOLUTION_LOW"

// Media resolution set to medium.

PartMediaResolutionLevelMediaResolutionMedium PartMediaResolutionLevel = "MEDIA_RESOLUTION_MEDIUM"

// Media resolution set to high.

PartMediaResolutionLevelMediaResolutionHigh PartMediaResolutionLevel = "MEDIA_RESOLUTION_HIGH"

// Media resolution set to ultra high.

PartMediaResolutionLevelMediaResolutionUltraHigh PartMediaResolutionLevel = "MEDIA_RESOLUTION_ULTRA_HIGH"

)

// The type of tool in the function call.

type ToolType string

const (

// Unspecified tool type.

ToolTypeUnspecified ToolType = "TOOL_TYPE_UNSPECIFIED"

// Google search tool, maps to Tool.google_search.search_types.web_search.

ToolTypeGoogleSearchWeb ToolType = "GOOGLE_SEARCH_WEB"

// Image search tool, maps to Tool.google_search.search_types.image_search.

ToolTypeGoogleSearchImage ToolType = "GOOGLE_SEARCH_IMAGE"

// URL context tool, maps to Tool.url_context.

ToolTypeURLContext ToolType = "URL_CONTEXT"

// Google maps tool, maps to Tool.google_maps.

ToolTypeGoogleMaps ToolType = "GOOGLE_MAPS"

// File search tool, maps to Tool.file_search.

ToolTypeFileSearch ToolType = "FILE_SEARCH"

)

// Resource scope.

type ResourceScope string

const (

// When setting base_url, this value configures resource scope to be the collection.

// The resource name will not include API version, project, or location.

// For example, if base_url is set to "https://aiplatform.googleapis.com",

// then the resource name for a Model would be

// "https://aiplatform.googleapis.com/publishers/google/models/gemini-3-pro-preview

ResourceScopeCollection ResourceScope = "COLLECTION"

)

// Pricing and performance service tier.

type ServiceTier string

const (

// Default service tier, which is standard.

ServiceTierUnspecified ServiceTier = "unspecified"

// Flex service tier.

ServiceTierFlex ServiceTier = "flex"

// Standard service tier.

ServiceTierStandard ServiceTier = "standard"

// Priority service tier.

ServiceTierPriority ServiceTier = "priority"

)

// Options for feature selection preference.

type FeatureSelectionPreference string

const (

FeatureSelectionPreferenceUnspecified FeatureSelectionPreference = "FEATURE_SELECTION_PREFERENCE_UNSPECIFIED"

FeatureSelectionPreferencePrioritizeQuality FeatureSelectionPreference = "PRIORITIZE_QUALITY"

FeatureSelectionPreferenceBalanced FeatureSelectionPreference = "BALANCED"

FeatureSelectionPreferencePrioritizeCost FeatureSelectionPreference = "PRIORITIZE_COST"

)

// Enum representing the Vertex embedding API to use.

type EmbeddingAPIType string

const (

// predict API endpoint (default)

EmbeddingAPITypePredict EmbeddingAPIType = "PREDICT"

// embedContent API Endpoint

EmbeddingAPITypeEmbedContent EmbeddingAPIType = "EMBED_CONTENT"

)

// Enum that controls the safety filter level for objectionable content.

type SafetyFilterLevel string

const (

SafetyFilterLevelBlockLowAndAbove SafetyFilterLevel = "BLOCK_LOW_AND_ABOVE"

SafetyFilterLevelBlockMediumAndAbove SafetyFilterLevel = "BLOCK_MEDIUM_AND_ABOVE"

SafetyFilterLevelBlockOnlyHigh SafetyFilterLevel = "BLOCK_ONLY_HIGH"

SafetyFilterLevelBlockNone SafetyFilterLevel = "BLOCK_NONE"

)

// Enum that specifies the language of the text in the prompt.

type ImagePromptLanguage string

const (

// Auto-detect the language.

ImagePromptLanguageAuto ImagePromptLanguage = "auto"

// English

ImagePromptLanguageEn ImagePromptLanguage = "en"

// Japanese

ImagePromptLanguageJa ImagePromptLanguage = "ja"

// Korean

ImagePromptLanguageKo ImagePromptLanguage = "ko"

// Hindi

ImagePromptLanguageHi ImagePromptLanguage = "hi"

// Chinese

ImagePromptLanguageZh ImagePromptLanguage = "zh"

// Portuguese

ImagePromptLanguagePt ImagePromptLanguage = "pt"

// Spanish

ImagePromptLanguageEs ImagePromptLanguage = "es"

)

// Enum representing the mask mode of a mask reference image.

type MaskReferenceMode string

const (

MaskReferenceModeMaskModeDefault MaskReferenceMode = "MASK_MODE_DEFAULT"

MaskReferenceModeMaskModeUserProvided MaskReferenceMode = "MASK_MODE_USER_PROVIDED"

MaskReferenceModeMaskModeBackground MaskReferenceMode = "MASK_MODE_BACKGROUND"

MaskReferenceModeMaskModeForeground MaskReferenceMode = "MASK_MODE_FOREGROUND"

MaskReferenceModeMaskModeSemantic MaskReferenceMode = "MASK_MODE_SEMANTIC"

)

// Enum representing the control type of a control reference image.

type ControlReferenceType string

const (

ControlReferenceTypeDefault ControlReferenceType = "CONTROL_TYPE_DEFAULT"

ControlReferenceTypeCanny ControlReferenceType = "CONTROL_TYPE_CANNY"

ControlReferenceTypeScribble ControlReferenceType = "CONTROL_TYPE_SCRIBBLE"

ControlReferenceTypeFaceMesh ControlReferenceType = "CONTROL_TYPE_FACE_MESH"

)

// Enum representing the subject type of a subject reference image.

type SubjectReferenceType string

const (

SubjectReferenceTypeSubjectTypeDefault SubjectReferenceType = "SUBJECT_TYPE_DEFAULT"

SubjectReferenceTypeSubjectTypePerson SubjectReferenceType = "SUBJECT_TYPE_PERSON"

SubjectReferenceTypeSubjectTypeAnimal SubjectReferenceType = "SUBJECT_TYPE_ANIMAL"

SubjectReferenceTypeSubjectTypeProduct SubjectReferenceType = "SUBJECT_TYPE_PRODUCT"

)

// Enum representing the editing mode.

type EditMode string

const (

EditModeDefault EditMode = "EDIT_MODE_DEFAULT"

EditModeInpaintRemoval EditMode = "EDIT_MODE_INPAINT_REMOVAL"

EditModeInpaintInsertion EditMode = "EDIT_MODE_INPAINT_INSERTION"

EditModeOutpaint EditMode = "EDIT_MODE_OUTPAINT"

EditModeControlledEditing EditMode = "EDIT_MODE_CONTROLLED_EDITING"

EditModeStyle EditMode = "EDIT_MODE_STYLE"

EditModeBgswap EditMode = "EDIT_MODE_BGSWAP"

EditModeProductImage EditMode = "EDIT_MODE_PRODUCT_IMAGE"

)

// Enum that represents the segmentation mode.

type SegmentMode string

const (

SegmentModeForeground SegmentMode = "FOREGROUND"

SegmentModeBackground SegmentMode = "BACKGROUND"

SegmentModePrompt SegmentMode = "PROMPT"

SegmentModeSemantic SegmentMode = "SEMANTIC"

SegmentModeInteractive SegmentMode = "INTERACTIVE"

)

// Enum for the reference type of a video generation reference image.

type VideoGenerationReferenceType string

const (

// A reference image that provides assets to the generated video,

// such as the scene, an object, a character, etc.

VideoGenerationReferenceTypeAsset VideoGenerationReferenceType = "ASSET"

// A reference image that provides aesthetics including colors,

// lighting, texture, etc., to be used as the style of the generated video,

// such as 'anime', 'photography', 'origami', etc.

VideoGenerationReferenceTypeStyle VideoGenerationReferenceType = "STYLE"

)

// Enum for the mask mode of a video generation mask.

type VideoGenerationMaskMode string

const (

// The image mask contains a masked rectangular region which is

// applied on the first frame of the input video. The object described in

// the prompt is inserted into this region and will appear in subsequent

// frames.

VideoGenerationMaskModeInsert VideoGenerationMaskMode = "INSERT"

// The image mask is used to determine an object in the

// first video frame to track. This object is removed from the video.

VideoGenerationMaskModeRemove VideoGenerationMaskMode = "REMOVE"

// The image mask is used to determine a region in the

// video. Objects in this region will be removed.

VideoGenerationMaskModeRemoveStatic VideoGenerationMaskMode = "REMOVE_STATIC"

// The image mask contains a masked rectangular region where

// the input video will go. The remaining area will be generated. Video

// masks are not supported.

VideoGenerationMaskModeOutpaint VideoGenerationMaskMode = "OUTPAINT"

)

// Enum that controls the compression quality of the generated videos.

type VideoCompressionQuality string

const (

// Optimized video compression quality. This will produce videos

// with a compressed, smaller file size.

VideoCompressionQualityOptimized VideoCompressionQuality = "OPTIMIZED"

// Lossless video compression quality. This will produce videos

// with a larger file size.

VideoCompressionQualityLossless VideoCompressionQuality = "LOSSLESS"

)

// Enum representing the tuning method.

type TuningMethod string

const (

// Supervised fine tuning.

TuningMethodSupervisedFineTuning TuningMethod = "SUPERVISED_FINE_TUNING"

// Preference optimization tuning.

TuningMethodPreferenceTuning TuningMethod = "PREFERENCE_TUNING"

// Distillation tuning.

TuningMethodDistillation TuningMethod = "DISTILLATION"

)

// State for the lifecycle of a File.

type FileState string

const (

FileStateUnspecified FileState = "STATE_UNSPECIFIED"

FileStateProcessing FileState = "PROCESSING"

FileStateActive FileState = "ACTIVE"

FileStateFailed FileState = "FAILED"

)

// Source of the File.

type FileSource string

const (

FileSourceUnspecified FileSource = "SOURCE_UNSPECIFIED"

FileSourceUploaded FileSource = "UPLOADED"

FileSourceGenerated FileSource = "GENERATED"

FileSourceRegistered FileSource = "REGISTERED"

)

// The reason why the turn is complete.

type TurnCompleteReason string

const (

// Default value. Reason is unspecified.

TurnCompleteReasonUnspecified TurnCompleteReason = "TURN_COMPLETE_REASON_UNSPECIFIED"

// The function call generated by the model is invalid.

TurnCompleteReasonMalformedFunctionCall TurnCompleteReason = "MALFORMED_FUNCTION_CALL"

// The response is rejected by the model.

TurnCompleteReasonResponseRejected TurnCompleteReason = "RESPONSE_REJECTED"

// Needs more input from the user.

TurnCompleteReasonNeedMoreInput TurnCompleteReason = "NEED_MORE_INPUT"

// Input content is prohibited.

TurnCompleteReasonProhibitedInputContent TurnCompleteReason = "PROHIBITED_INPUT_CONTENT"

// Input image contains prohibited content.

TurnCompleteReasonImageProhibitedInputContent TurnCompleteReason = "IMAGE_PROHIBITED_INPUT_CONTENT"

// Input text contains prominent person reference.

TurnCompleteReasonInputTextContainProminentPersonProhibited TurnCompleteReason = "INPUT_TEXT_CONTAIN_PROMINENT_PERSON_PROHIBITED"

// Input image contains celebrity.

TurnCompleteReasonInputImageCelebrity TurnCompleteReason = "INPUT_IMAGE_CELEBRITY"

// Input image contains photo realistic child.

TurnCompleteReasonInputImagePhotoRealisticChildProhibited TurnCompleteReason = "INPUT_IMAGE_PHOTO_REALISTIC_CHILD_PROHIBITED"

// Input text contains NCII content.

TurnCompleteReasonInputTextNciiProhibited TurnCompleteReason = "INPUT_TEXT_NCII_PROHIBITED"

// Other input safety issue.

TurnCompleteReasonInputOther TurnCompleteReason = "INPUT_OTHER"

// Input contains IP violation.

TurnCompleteReasonInputIpProhibited TurnCompleteReason = "INPUT_IP_PROHIBITED"

// Input matched blocklist.

TurnCompleteReasonBlocklist TurnCompleteReason = "BLOCKLIST"

// Input is unsafe for image generation.

TurnCompleteReasonUnsafePromptForImageGeneration TurnCompleteReason = "UNSAFE_PROMPT_FOR_IMAGE_GENERATION"

// Generated image failed safety check.

TurnCompleteReasonGeneratedImageSafety TurnCompleteReason = "GENERATED_IMAGE_SAFETY"

// Generated content failed safety check.

TurnCompleteReasonGeneratedContentSafety TurnCompleteReason = "GENERATED_CONTENT_SAFETY"

// Generated audio failed safety check.

TurnCompleteReasonGeneratedAudioSafety TurnCompleteReason = "GENERATED_AUDIO_SAFETY"

// Generated video failed safety check.

TurnCompleteReasonGeneratedVideoSafety TurnCompleteReason = "GENERATED_VIDEO_SAFETY"

// Generated content is prohibited.

TurnCompleteReasonGeneratedContentProhibited TurnCompleteReason = "GENERATED_CONTENT_PROHIBITED"

// Generated content matched blocklist.

TurnCompleteReasonGeneratedContentBlocklist TurnCompleteReason = "GENERATED_CONTENT_BLOCKLIST"

// Generated image is prohibited.

TurnCompleteReasonGeneratedImageProhibited TurnCompleteReason = "GENERATED_IMAGE_PROHIBITED"

// Generated image contains celebrity.

TurnCompleteReasonGeneratedImageCelebrity TurnCompleteReason = "GENERATED_IMAGE_CELEBRITY"

// Generated image contains prominent people detected by rewriter.

TurnCompleteReasonGeneratedImageProminentPeopleDetectedByRewriter TurnCompleteReason = "GENERATED_IMAGE_PROMINENT_PEOPLE_DETECTED_BY_REWRITER"

// Generated image contains identifiable people.

TurnCompleteReasonGeneratedImageIdentifiablePeople TurnCompleteReason = "GENERATED_IMAGE_IDENTIFIABLE_PEOPLE"

// Generated image contains minors.

TurnCompleteReasonGeneratedImageMinors TurnCompleteReason = "GENERATED_IMAGE_MINORS"

// Generated image contains IP violation.

TurnCompleteReasonOutputImageIpProhibited TurnCompleteReason = "OUTPUT_IMAGE_IP_PROHIBITED"

// Other generated content issue.

TurnCompleteReasonGeneratedOther TurnCompleteReason = "GENERATED_OTHER"

// Max regeneration attempts reached.

TurnCompleteReasonMaxRegenerationReached TurnCompleteReason = "MAX_REGENERATION_REACHED"

)

// Server content modalities.

type MediaModality string

const (

// The modality is unspecified.

MediaModalityUnspecified MediaModality = "MODALITY_UNSPECIFIED"

// Plain text.

MediaModalityText MediaModality = "TEXT"

// Images.

MediaModalityImage MediaModality = "IMAGE"

// Video.

MediaModalityVideo MediaModality = "VIDEO"

// Audio.

MediaModalityAudio MediaModality = "AUDIO"

// Document, e.g. PDF.

MediaModalityDocument MediaModality = "DOCUMENT"

)

// The type of the VAD signal.

type VADSignalType string

const (