Google Gen AI Go SDK

https://pkg.go.dev/google.golang.org/genai
Admin
The Google Gen AI Go SDK provides a Go package for interacting with Google's Gemini multimodal...
Tokens:129,598
Snippets:1,393
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### ConvertBidiSetupToTokenSetup Function

Source: https://pkg.go.dev/google.golang.org/genai

Converts BidiGenerateContentSetup to token setup.

```go
func ConvertBidiSetupToTokenSetup(
	body map[string]any,
	config *CreateAuthTokenConfig,
) map[string]any
```

--------------------------------

### ReinforcementTuningExample struct

Source: https://pkg.go.dev/google.golang.org/genai

Represents the user-facing format for Gemini Reinforcement Tuning examples on Vertex.

```go
type ReinforcementTuningExample struct {
	// Multi-turn contents that represents the Prompt.
	Contents []*Content `json:"contents,omitempty"`
	// Optional. References for the given prompt. The key is the name of the reference,
	// and the value is the reference itself.
	References map[string]string `json:"references,omitempty"`
	// Corresponds to system_instruction in user-facing GenerateContentRequest.
	SystemInstruction *Content `json:"systemInstruction,omitempty"`
}
```

--------------------------------

### CountTokens example output

Source: https://pkg.go.dev/google.golang.org/genai/tokenizer

Example output showing the total token count.

```text
Output:
total token count: 4
```

--------------------------------

### AudioTranscriptionConfig struct

Source: https://pkg.go.dev/google.golang.org/genai

The audio transcription configuration in Setup.

```go
type AudioTranscriptionConfig struct {
	// Optional. BCP-47 language codes providing hints about the languages present in the
	// audio. If omitted or empty, defaults to automatic language detection.
	LanguageCodes []string `json:"languageCodes,omitempty"`
	// Optional. Deprecated: Auto-detection is now the default when language_codes is omitted.
	// This field will be removed in a future version.
	LanguageAuto *LanguageAuto `json:"languageAuto,omitempty"`
	// Optional. Deprecated: Use top-level language_codes instead. This field will be removed
	// in a future version.
	LanguageHints *LanguageHints `json:"languageHints,omitempty"`
	// Optional. A list of custom vocabulary phrases, which biases the ASR model to improve
	// recognition of these specific terms.
	CustomVocabulary []string `json:"customVocabulary,omitempty"`
	// Optional. Deprecated. A list of phrases used for speech adaptation, which biases
	// the ASR model to improve recognition of these specific terms.
	AdaptationPhrases []string `json:"adaptationPhrases,omitempty"`
	// Optional. Configures speaker diarization.
	Diarization *bool `json:"diarization,omitempty"`
	// Optional. Configures word-level timestamp generation.
	WordTimestamp *bool `json:"wordTimestamp,omitempty"`
	// Optional. Configures transcription mode. Supported values: `VERBATIM`, `SMART`. If
	// unspecified, defaults to `VERBATIM` transcription. In `SMART` mode, the model performs
	// disfluency removal (eliminating filler words, repetitions, and false starts), light
	// grammatical cleanup, automatic formatting (paragraphs, bullet points, numbered lists),
	// and minor user edits (inline self-corrections). Timestamps and diarization are incompatible
	// with mode `SMART`.
	Mode AudioTranscriptionConfigMode `json:"mode,omitempty"`
}
```

--------------------------------

### ActivityStart struct definition

Source: https://pkg.go.dev/google.golang.org/genai

Marks the start of user activity. This can only be sent if automatic server-side activity detection is disabled.

```go
type ActivityStart struct {
}
```

--------------------------------

### GetFileSearchStoreConfig struct

Source: https://pkg.go.dev/google.golang.org/genai

Optional parameters for getting a FileSearchStore.

```go
type GetFileSearchStoreConfig struct {
	// Optional. Used to override HTTP request options.
	HTTPOptions *HTTPOptions `json:"httpOptions,omitempty"`
}
```

--------------------------------

### TuningExample struct definition

Source: https://pkg.go.dev/google.golang.org/genai

Represents a single example for tuning. Note that this data type is not supported in Vertex AI.

```go
type TuningExample struct {
	// Required. The expected model output.
	Output string `json:"output,omitempty"`
	// Optional. Text model input.
	TextInput string `json:"textInput,omitempty"`
}
```

--------------------------------

### LiveServerSetupComplete struct

Source: https://pkg.go.dev/google.golang.org/genai

Sent in response to a LiveGenerateContentSetup message from the client to confirm session setup.

```go
type LiveServerSetupComplete struct {
	// Optional. The session ID of the live session.
	SessionID string `json:"sessionId,omitempty"`
	// Optional. Signature of the verified consent audio. This is populated when the
	// request has a ReplicatedVoiceConfig with consent_audio set, if the consent
	// verification was successful. This may be used in a subsequent request
	// instead of the consent_audio to verify the same consent.
	VoiceConsentSignature *VoiceConsentSignature `json:"voiceConsentSignature,omitempty"`
}
```

--------------------------------

### GeminiPreferenceExample struct

Source: https://pkg.go.dev/google.golang.org/genai

Input example for preference optimization. This data type is not supported in the Gemini API.

```go
type GeminiPreferenceExample struct {
	// List of completions for a given prompt.
	Completions []*GeminiPreferenceExampleCompletion `json:"completions,omitempty"`
	// Multi-turn contents that represents the Prompt.
	Contents []*Content `json:"contents,omitempty"`
}
```

--------------------------------

### Chat session usage

Source: https://pkg.go.dev/google.golang.org/genai

Chat represents a single chat session with the model. The example shows initializing a client, creating a chat, and sending a message.

```go
type Chat struct {
	Models
	// contains filtered or unexported fields
}
```

```go
	client, _ := genai.NewClient(ctx, &genai.ClientConfig{})
	chat, _ := client.Chats.Create(ctx, "gemini-2.5-flash", nil, nil)
  result, err = chat.SendMessage(ctx, genai.Part{Text: "What is 1 + 2?"})
```

--------------------------------

### Create client from environment variables

Source: https://pkg.go.dev/google.golang.org/genai

Initializes a client using the configuration provided via environment variables.

```go
client, err := genai.NewClient(ctx, &genai.ClientConfig{})
```

--------------------------------

### Cloud Run Reward Scorer HTTP API Request and Response Examples

Source: https://pkg.go.dev/google.golang.org/genai

Examples of the JSON request and response bodies for a Cloud Run reward scorer service.

```json
{
  "example": {
    "contents": [
      {
        "role": "user",
        "parts": [
          {
            "text": "What is the capital of France?"
          }
        ]
      }
    ],
    "references": {
      "answer": "Paris"
    }
  },
  "response": {
    "parts": [
      {
        "text": "London"
      }
    ]
  },
  "metadata": {
    "step": 1,
    "tuning_job_id": 123456789
  }
}
```

```json
{
  "reward": -1.0
}
```

--------------------------------

### LiveClientSetup struct

Source: https://pkg.go.dev/google.golang.org/genai

Contains configuration that applies for the duration of the streaming session.

```go
type LiveClientSetup struct {
	// The fully qualified name of the publisher model or tuned model endpoint to
	// use.
	Model string `json:"model,omitempty"`
	// Optional. The generation configuration for the session.
	// Note: only a subset of fields are supported.
	GenerationConfig *GenerationConfig `json:"generationConfig,omitempty"`
	// Optional. The user provided system instructions for the model.
	// Note: only text should be used in parts and content in each part will be
	// in a separate paragraph.
	SystemInstruction *Content `json:"systemInstruction,omitempty"`
	// Optional. A list of `Tools` the model may use to generate the next response.
	// A `Tool` is a piece of code that enables the system to interact with
	// external systems to perform an action, or set of actions, outside of
	// knowledge and scope of the model.
	Tools []*Tool `json:"tools,omitempty"`
	// Optional. Configures the realtime input behavior in BidiGenerateContent.
	RealtimeInputConfig *RealtimeInputConfig `json:"realtimeInputConfig,omitempty"`
	// Optional. Configures session resumption mechanism.
	// If included server will send SessionResumptionUpdate messages.
	SessionResumption *SessionResumptionConfig `json:"sessionResumption,omitempty"`
	// Optional. Configures context window compression mechanism.
	// If included, server will compress context window to fit into given length.
	ContextWindowCompression *ContextWindowCompressionConfig `json:"contextWindowCompression,omitempty"`
	// Optional. The transcription of the input aligns with the input audio language.
	InputAudioTranscription *AudioTranscriptionConfig `json:"inputAudioTranscription,omitempty"`
	// Optional. The transcription of the output aligns with the language code
	// specified for the output audio.
	OutputAudioTranscription *AudioTranscriptionConfig `json:"outputAudioTranscription,omitempty"`
	// Optional. Configures the proactivity of the model. This allows the model to respond
	// proactively to
	// the input and to ignore irrelevant input.
	Proactivity *ProactivityConfig `json:"proactivity,omitempty"`
	// Optional. Configures the explicit VAD signal. If enabled, the client will send
	// vad_signal to indicate the start and end of speech. This allows the server
	// to process the audio more efficiently.
	ExplicitVADSignal bool `json:"explicitVadSignal,omitempty"`
	// Optional. Configures the avatar model behavior.
	AvatarConfig *AvatarConfig `json:"avatarConfig,omitempty"`
	// Optional. Safety settings in the request to block unsafe content in the
	// response.
	SafetySettings []*SafetySetting `json:"safetySettings,omitempty"`
	// Optional. Configures the exchange of history between the client and the server.
	HistoryConfig *HistoryConfig `json:"historyConfig,omitempty"`
}
```

--------------------------------

### Caches.Get method

Source: https://pkg.go.dev/google.golang.org/genai

Gets a cached content resource.

```go
func (m Caches) Get(ctx context.Context, name string, config *GetCachedContentConfig) (*CachedContent, error)
```

--------------------------------

### ClientConfig method

Source: https://pkg.go.dev/google.golang.org/genai

Returns a copy of the ClientConfig used to create the client.

```go
func (c Client) ClientConfig() ClientConfig
```

--------------------------------

### Chats.Create method

Source: https://pkg.go.dev/google.golang.org/genai

Create initializes a new chat session.

```go
func (c *Chats) Create(ctx context.Context, model string, config *GenerateContentConfig, history []*Content) (*Chat, error)
```

--------------------------------

### FileSearchStores Get method

Source: https://pkg.go.dev/google.golang.org/genai

Retrieves a specific FileSearchStore resource by name.

```go
func (m FileSearchStores) Get(ctx context.Context, name string, config *GetFileSearchStoreConfig) (*FileSearchStore, error)
```

--------------------------------

### PrebuiltVoiceConfig Struct

Source: https://pkg.go.dev/google.golang.org/genai

Configuration for a prebuilt voice.

```go
type PrebuiltVoiceConfig struct {
	// The name of the prebuilt voice to use.
	VoiceName string `json:"voiceName,omitempty"`
}
```

--------------------------------

### Live.Connect method

Source: https://pkg.go.dev/google.golang.org/genai

Establishes a WebSocket connection to the specified model.

```go
func (r *Live) Connect(context context.Context, model string, config *LiveConnectConfig) (*Session, error)
```

--------------------------------

### func (Documents) Get

Source: https://pkg.go.dev/google.golang.org/genai

Retrieves a specific document resource by name.

```APIDOC
## func (Documents) Get

### Description
Retrieves a single document resource by its name.

### Signature
`func (m Documents) Get(ctx context.Context, name string, config *GetDocumentConfig) (*Document, error)`
```

--------------------------------

### NewPartFromFile constructor

Source: https://pkg.go.dev/google.golang.org/genai

Builds a Part from a given File.

```go
func NewPartFromFile(file File) *Part
```

--------------------------------

### Interval struct

Source: https://pkg.go.dev/google.golang.org/genai

Represents a time interval with an inclusive start and exclusive end.

```go
type Interval struct {
	// Optional. Exclusive end of the interval. If specified, a Timestamp matching this
	// interval will have to be before the end.
	EndTime time.Time `json:"endTime,omitempty"`
	// Optional. Inclusive start of the interval. If specified, a Timestamp matching this
	// interval will have to be the same or after the start.
	StartTime time.Time `json:"startTime,omitempty"`
}
```

--------------------------------

### Create a Gemini Enterprise Agent Platform client

Source: https://pkg.go.dev/google.golang.org/genai

Initializes a client for the Gemini Enterprise Agent Platform using project and location details.

```go
client, err := genai.NewClient(ctx, &genai.ClientConfig{
	Project:  project,
	Location: location,
	Backend:  genai.BackendEnterprise,
})
```

--------------------------------

### Create a Gemini API client

Source: https://pkg.go.dev/google.golang.org/genai

Initializes a client for the Gemini Developer API using an API key.

```go
client, err := genai.NewClient(ctx, &genai.ClientConfig{
	APIKey:   apiKey,
	Backend:  genai.BackendGeminiAPI,
})
```

--------------------------------

### NewClient

Source: https://pkg.go.dev/google.golang.org/genai

Initializes a new GenAI client instance.

```APIDOC
## func NewClient(ctx context.Context, cc *ClientConfig) (*Client, error)

### Description
Creates a new client instance for interacting with the GenAI service using the provided configuration.

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **cc** (*ClientConfig) - Required - The configuration settings for the client.
```

--------------------------------

### URLContextMetadata struct

Source: https://pkg.go.dev/google.golang.org/genai

Metadata returned when the model uses the url_context tool to get information from a user-provided URL.

```go
type URLContextMetadata struct {
	// Output only. A list of URL metadata, with one entry for each URL retrieved by the
	// tool.
	URLMetadata []*URLMetadata `json:"urlMetadata,omitempty"`
}
```

--------------------------------

### NewDownloadURIFromVideo function

Source: https://pkg.go.dev/google.golang.org/genai

Creates a DownloadURI from a Video.

```go
func NewDownloadURIFromVideo(v *Video) DownloadURI
```

--------------------------------

### ComputerUse struct

Source: https://pkg.go.dev/google.golang.org/genai

Tool configuration to support computer use capabilities.

```go
type ComputerUse struct {
	// Required. The environment being operated.
	Environment Environment `json:"environment,omitempty"`
	// Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions)
	// are included in the final model call. Some of them can be explicitly excluded from
	// being automatically included. This can serve two purposes: 1. Using a more restricted
	// / different action space. 2. Improving the definitions / instructions of predefined
	// functions.
	ExcludedPredefinedFunctions []string `json:"excludedPredefinedFunctions,omitempty"`
	// Optional. Enables the prompt injection detection check on computer-use request.
	EnablePromptInjectionDetection *bool `json:"enablePromptInjectionDetection,omitempty"`
	// Optional. Disabled safety policies for computer use. This field is not supported
	// in Vertex AI.
	DisabledSafetyPolicies []SafetyPolicy `json:"disabledSafetyPolicies,omitempty"`
}
```

--------------------------------

### SpeakerVoiceConfig struct

Source: https://pkg.go.dev/google.golang.org/genai

Configuration for a single speaker in a multi-speaker setup, requiring a speaker name and voice configuration.

```go
type SpeakerVoiceConfig struct {
	// Required. The name of the speaker. This should be the same as the speaker name used
	// in the prompt.
	Speaker string `json:"speaker,omitempty"`
	// Required. The configuration for the voice of this speaker.
	VoiceConfig *VoiceConfig `json:"voiceConfig,omitempty"`
}
```

--------------------------------

### Files.All method

Source: https://pkg.go.dev/google.golang.org/genai

Retrieves all file resources using an iterator, handling pagination internally.

```go
func (m Files) All(ctx context.Context) iter.Seq2[*File, error]
```

--------------------------------

### type Interval

Source: https://pkg.go.dev/google.golang.org/genai

Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).

```APIDOC
## type Interval

### Description
Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end.

### Fields
- **EndTime** (time.Time) - Optional - Exclusive end of the interval.
- **StartTime** (time.Time) - Optional - Inclusive start of the interval.
```

--------------------------------

### RAGChunkPageSpan struct

Source: https://pkg.go.dev/google.golang.org/genai

Represents the 1-indexed page range where a chunk starts and ends in a document. This data type is not supported in the Gemini API.

```go
type RAGChunkPageSpan struct {
	// Page where chunk starts in the document. Inclusive. 1-indexed.
	FirstPage int32 `json:"firstPage,omitempty"`
	// Page where chunk ends in the document. Inclusive. 1-indexed.
	LastPage int32 `json:"lastPage,omitempty"`
}
```

--------------------------------

### Live.Connect

Source: https://pkg.go.dev/google.golang.org/genai

Establishes a live session connection with a specified model.

```APIDOC
## func (r *Live) Connect(context context.Context, model string, config *LiveConnectConfig) (*Session, error)

### Description
Connects to a live session for a specific model using the provided configuration.

### Parameters
- **context** (context.Context) - Required - The context for the connection.
- **model** (string) - Required - The identifier of the model to connect to.
- **config** (*LiveConnectConfig) - Optional - Configuration parameters for the live connection.
```

--------------------------------

### NewControlReferenceImage

Source: https://pkg.go.dev/google.golang.org/genai

Creates a new ControlReferenceImage instance used for image editing operations where a control image guides the model's output.

```APIDOC
## func NewControlReferenceImage(referenceImage *Image, referenceID int32, config *ControlReferenceConfig) *ControlReferenceImage

### Description
Creates a new ControlReferenceImage object. This object represents a sketch or reference image used to guide the model during image generation or editing.

### Parameters
- **referenceImage** (*Image) - Required - The reference image for the editing operation.
- **referenceID** (int32) - Required - The ID of the reference image.
- **config** (*ControlReferenceConfig) - Required - Configuration settings for the control reference image, including control type and computation settings.
```

--------------------------------

### CreateAuthTokenConfig struct

Source: https://pkg.go.dev/google.golang.org/genai

Configuration for optional parameters when creating an authentication token.

```go
type CreateAuthTokenConfig struct {
	// Optional. Used to override HTTP request options.
	HTTPOptions *HTTPOptions `json:"httpOptions,omitempty"`
	// Optional. An optional time after which, when using the resulting token,
	// messages in Live API sessions will be rejected. (Gemini may
	// preemptively close the session after this time.)
	// If not set then this defaults to 30 minutes in the future. If set, this
	// value must be less than 20 hours in the future.
	ExpireTime time.Time `json:"expireTime,omitempty"`
	// Optional. The time after which new Live API sessions using the token
	// resulting from this request will be rejected.
	// If not set this defaults to 60 seconds in the future. If set, this value
	// must be less than 20 hours in the future.
	NewSessionExpireTime time.Time `json:"newSessionExpireTime,omitempty"`
	// Optional. The number of times the token can be used. If this value is zero
	// then no limit is applied. Default is 1. Resuming a Live API session does
	// not count as a use.
	Uses *int32 `json:"uses,omitempty"`
	// Optional. Configuration specific to Live API connections created using this token.
	LiveConnectConstraints *LiveConnectConstraints `json:"liveConnectConstraints,omitempty"`
	// Optional. Additional fields to lock in the effective LiveConnectParameters.
	LockAdditionalFields []string `json:"lockAdditionalFields,omitempty"`
}
```

--------------------------------

### VADSignalType Definition and Constants

Source: https://pkg.go.dev/google.golang.org/genai

Defines the VAD signal type and its possible values, including unspecified, start of sentence, and end of sentence signals.

```go
type VADSignalType string
```

```go
const (
	// The default is VAD_SIGNAL_TYPE_UNSPECIFIED.
	VADSignalTypeUnspecified VADSignalType = "VAD_SIGNAL_TYPE_UNSPECIFIED"
	// Start of sentence signal.
	VADSignalTypeSos VADSignalType = "VAD_SIGNAL_TYPE_SOS"
	// End of sentence signal.
	VADSignalTypeEos VADSignalType = "VAD_SIGNAL_TYPE_EOS"
)
```

--------------------------------

### Files.Get method

Source: https://pkg.go.dev/google.golang.org/genai

Retrieves a file by name.

```go
func (m Files) Get(ctx context.Context, name string, config *GetFileConfig) (*File, error)
```

--------------------------------

### NewDownloadURIFromFile function

Source: https://pkg.go.dev/google.golang.org/genai

Creates a DownloadURI from a File.

```go
func NewDownloadURIFromFile(f *File) DownloadURI
```

--------------------------------

### TuningDataset struct definition

Source: https://pkg.go.dev/google.golang.org/genai

Defines the supervised fine-tuning training dataset, supporting GCS URIs, Vertex AI dataset resources, or inline examples.

```go
type TuningDataset struct {
	// Optional. GCS URI of the file containing training dataset in JSONL format.
	GCSURI string `json:"gcsUri,omitempty"`
	// Optional. The resource name of the Gemini Enterprise Agent Platform (previously known
	// as Vertex AI) Multimodal Dataset that is used as training dataset. Example: 'projects/my-project-id-or-number/locations/my-location/datasets/my-dataset-id'.
	VertexDatasetResource string `json:"vertexDatasetResource,omitempty"`
	// Optional. Inline examples with simple input/output text.
	Examples []*TuningExample `json:"examples,omitempty"`
}
```

--------------------------------

### NewContentFromParts

Source: https://pkg.go.dev/google.golang.org/genai

Builds a Content from a list of parts and a Role. Defaults to RoleUser if role is empty.

```go
func NewContentFromParts(parts []*Part, role Role) *Content
```

--------------------------------

### SendRealtimeInput method for Session

Source: https://pkg.go.dev/google.golang.org/genai

Transmits realtime audio chunks and video frames to the model, optimized for responsiveness.

```go
func (s *Session) SendRealtimeInput(input LiveRealtimeInput) error
```

--------------------------------

### POST / (Cloud Run Reward Scorer)

Source: https://pkg.go.dev/google.golang.org/genai

The Cloud Run service must implement a POST endpoint to receive tuning examples and model responses, returning a calculated reward value.

```APIDOC
## POST /

### Description
This endpoint is invoked by the Vertex AI tuning service to compute a reward for a given model response based on a training example.

### Method
POST

### Request Body
- **example** (object) - The training example in ProtoJSON format.
- **response** (object) - The model response in ProtoJSON format.
- **metadata** (object) - Contains 'step' (int) and 'tuning_job_id' (int64).

### Request Example
{
  "example": {
    "contents": [
      { "role": "user", "parts": [{ "text": "What is the capital of France?" }] }
    ],
    "references": { "answer": "Paris" }
  },
  "response": {
    "parts": [{ "text": "London" }]
  },
  "metadata": { "step": 1, "tuning_job_id": 123456789 }
}

### Response
#### Success Response (200)
- **reward** (float) - The calculated reward, clipped to the range [-1, 1].
- **user_requested_aux_info** (string) - Optional debugging information.

#### Response Example
{
  "reward": -1.0
}
```

--------------------------------

### CreateTuningJobConfig struct

Source: https://pkg.go.dev/google.golang.org/genai

Configuration parameters for creating a tuning job, supporting various tuning methods and hyperparameter settings.

```go
type CreateTuningJobConfig struct {
	// Optional. Used to override HTTP request options.
	HTTPOptions *HTTPOptions `json:"httpOptions,omitempty"`
	// The method to use for tuning (SUPERVISED_FINE_TUNING or PREFERENCE_TUNING or DISTILLATION
	// or REINFORCEMENT_TUNING). If not set, the default method (SFT) will be used.
	Method TuningMethod `json:"method,omitempty"`
	// Optional. Validation dataset for tuning. The dataset must be formatted as a JSONL
	// file.
	ValidationDataset *TuningValidationDataset `json:"validationDataset,omitempty"`
	// Optional. The display name of the tuned Model. The name can be up to 128 characters
	// long and can consist of any UTF-8 characters.
	TunedModelDisplayName string `json:"tunedModelDisplayName,omitempty"`
	// Optional. The description of the TuningJob
	Description string `json:"description,omitempty"`
	// Optional. Number of complete passes the model makes over the entire training dataset
	// during training.
	EpochCount *int32 `json:"epochCount,omitempty"`
	// Optional. Multiplier for adjusting the default learning rate. 1P models only. Mutually
	// exclusive with learning_rate.
	LearningRateMultiplier *float32 `json:"learningRateMultiplier,omitempty"`
	// Optional. If set to true, disable intermediate checkpoints and only the last checkpoint
	// will be exported. Otherwise, enable intermediate checkpoints.
	ExportLastCheckpointOnly *bool `json:"exportLastCheckpointOnly,omitempty"`
	// Optional. The optional checkpoint ID of the pre-tuned model to use for tuning, if
	// applicable.
	PreTunedModelCheckpointID string `json:"preTunedModelCheckpointId,omitempty"`
	// Optional. Adapter size for tuning.
	AdapterSize AdapterSize `json:"adapterSize,omitempty"`
	// Optional. Tuning mode for tuning.
	TuningMode TuningMode `json:"tuningMode,omitempty"`
	// Optional. Custom base model for tuning. This is only supported for OSS models in
	// Gemini Enterprise Agent Platform.
	CustomBaseModel string `json:"customBaseModel,omitempty"`
	// Optional. The batch size hyperparameter for tuning. This is only supported for OSS
	// models in Gemini Enterprise Agent Platform.
	BatchSize *int32 `json:"batchSize,omitempty"`
	// Optional. The learning rate for tuning. OSS models only. Mutually exclusive with
	// learning_rate_multiplier.
	LearningRate *float32 `json:"learningRate,omitempty"`
	// Optional. The labels with user-defined metadata to organize TuningJob and generated
	// resources such as Model and Endpoint. Label keys and values can be no longer than
	// 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters,
	// underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf
	// for more information and examples of labels.
	Labels map[string]string `json:"labels,omitempty"`
	// Optional. Weight for KL Divergence regularization, Preference Optimization tuning
	// only.
	Beta *float32 `json:"beta,omitempty"`
	// Optional. The base teacher model that is being distilled. Distillation only.
	BaseTeacherModel string `json:"baseTeacherModel,omitempty"`
	// Optional. The resource name of the Tuned teacher model. Distillation only.
	TunedTeacherModelSource string `json:"tunedTeacherModelSource,omitempty"`
	// Optional. Multiplier for adjusting the weight of the SFT loss. Distillation only.
	SftLossWeightMultiplier *float32 `json:"sftLossWeightMultiplier,omitempty"`
	// Optional. The Google Cloud Storage location where the tuning job outputs are written.
	OutputURI string `json:"outputUri,omitempty"`
	// Optional. The encryption spec of the tuning job. Customer-managed encryption key
```

--------------------------------

### AuthToken struct

Source: https://pkg.go.dev/google.golang.org/genai

Configuration for auth_tokens.create parameters.

```go
type AuthToken struct {
	// Optional. The name of the auth token.
	Name string `json:"name,omitempty"`
	// Optional. Input only. Immutable. An optional time after which, when using the resulting
	// token, messages in BidiGenerateContent sessions will be rejected. (Gemini may preemptively
	// close the session after this time.) If not set then this defaults to 30 minutes in
	// the future. If set, this value must be less than 20 hours in the future.
	ExpireTime string `json:"expireTime,omitempty"`
	// Optional. Input only. Immutable. The time after which new Live API sessions using
	// the token resulting from this request will be rejected. If not set this defaults
	// to 60 seconds in the future. If set, this value must be less than 20 hours in the
	// future.
	NewSessionExpireTime string `json:"newSessionExpireTime,omitempty"`
	// Optional. Input only. Immutable. The number of times the token can be used. If this
	// value is zero then no limit is applied. Resuming a Live API session does not count
	// as a use. If unspecified, the default is 1.
	Uses int32 `json:"uses,omitempty"`
}
```

--------------------------------

### NewDownloadURIFromGeneratedVideo function

Source: https://pkg.go.dev/google.golang.org/genai

Creates a DownloadURI from a GeneratedVideo.

```go
func NewDownloadURIFromGeneratedVideo(v *GeneratedVideo) DownloadURI
```

--------------------------------

### NewContentFromExecutableCode

Source: https://pkg.go.dev/google.golang.org/genai

Builds a Content from a single piece of source code in the given Language. Defaults to RoleUser if role is empty.

```go
func NewContentFromExecutableCode(code string, language Language, role Role) *Content
```

--------------------------------

### CreateFileSearchStoreConfig struct

Source: https://pkg.go.dev/google.golang.org/genai

Optional parameters for configuring a file search store, including display name and embedding model selection.

```go
type CreateFileSearchStoreConfig struct {
	// Optional. Used to override HTTP request options.
	HTTPOptions *HTTPOptions `json:"httpOptions,omitempty"`
	// Optional. The human-readable display name for the file search store.
	DisplayName string `json:"displayName,omitempty"`
	// Optional. The embedding model to use for the FileSearchStore.
	// Format: `models/{model}`. If not specified, the default embedding model will be used.
	EmbeddingModel string `json:"embeddingModel,omitempty"`
}
```

--------------------------------

### ListFileSearchStoresConfig struct

Source: https://pkg.go.dev/google.golang.org/genai

Optional parameters for listing FileSearchStore.

```go
type ListFileSearchStoresConfig struct {
	// Optional. Used to override HTTP request options.
	HTTPOptions *HTTPOptions `json:"httpOptions,omitempty"`
	// Optional. PageSize specifies the maximum number of cached contents to return per
	// API call. If zero, the server will use a default value.
	PageSize int32 `json:"pageSize,omitempty"`
	// Optional. PageToken represents a token used for pagination in API responses. It's
	// an opaque string that should be passed to subsequent requests to retrieve the next
	// page of results. An empty PageToken typically indicates that there are no further
	// pages available.
	PageToken string `json:"pageToken,omitempty"`
}
```

--------------------------------

### ListDocumentsConfig struct

Source: https://pkg.go.dev/google.golang.org/genai

Configuration for optional parameters when listing documents.

```go
type ListDocumentsConfig struct {
	// Optional. Used to override HTTP request options.
	HTTPOptions *HTTPOptions `json:"httpOptions,omitempty"`
	// Optional. PageSize specifies the maximum number of cached contents to return per
	// API call. If zero, the server will use a default value.
	PageSize int32 `json:"pageSize,omitempty"`
	// Optional. PageToken represents a token used for pagination in API responses. It's
	// an opaque string that should be passed to subsequent requests to retrieve the next
	// page of results. An empty PageToken typically indicates that there are no further
	// pages available.
	PageToken string `json:"pageToken,omitempty"`
}
```

--------------------------------

### DownloadURI Constructors

Source: https://pkg.go.dev/google.golang.org/genai

Constructor functions to create DownloadURI instances from different resource types.

```APIDOC
## DownloadURI Constructors

### Description
Functions to create a DownloadURI from specific resource types.

### Methods
- `NewDownloadURIFromFile(f *File) DownloadURI`
- `NewDownloadURIFromGeneratedVideo(v *GeneratedVideo) DownloadURI`
- `NewDownloadURIFromVideo(v *Video) DownloadURI`
```

--------------------------------

### Documents.All method

Source: https://pkg.go.dev/google.golang.org/genai

Retrieves all document resources, handling pagination internally and returning an iterator.

```go
func (m Documents) All(ctx context.Context, parent string) iter.Seq2[*Document, error]
```

--------------------------------

### FileSearchStores Create method

Source: https://pkg.go.dev/google.golang.org/genai

Creates a new FileSearchStore resource.

```go
func (m FileSearchStores) Create(ctx context.Context, config *CreateFileSearchStoreConfig) (*FileSearchStore, error)
```

--------------------------------

### Tokens.Create method

Source: https://pkg.go.dev/google.golang.org/genai

Creates a new cached content resource.

```go
func (m Tokens) Create(ctx context.Context, config *CreateAuthTokenConfig) (*AuthToken, error)
```

--------------------------------

### Files.Download method

Source: https://pkg.go.dev/google.golang.org/genai

Downloads a file from the specified URI.

```go
func (m Files) Download(ctx context.Context, uri DownloadURI, config *DownloadFileConfig) ([]byte, error)
```

--------------------------------

### Environment type and constants

Source: https://pkg.go.dev/google.golang.org/genai

Defines the operating environment for the application, defaulting to browser.

```go
type Environment string
```

```go
const (
	// Defaults to browser.
	EnvironmentUnspecified Environment = "ENVIRONMENT_UNSPECIFIED"
	// Operates in a web browser.
	EnvironmentBrowser Environment = "ENVIRONMENT_BROWSER"
	// Operates in a mobile environment.
	EnvironmentMobile Environment = "ENVIRONMENT_MOBILE"
	// Operates in a desktop environment.
	EnvironmentDesktop Environment = "ENVIRONMENT_DESKTOP"
)
```

--------------------------------

### Batches.Create Method

Source: https://pkg.go.dev/google.golang.org/genai

Creates a new batch job.

```go
func (b Batches) Create(ctx context.Context, model string, src *BatchJobSource, config *CreateBatchJobConfig) (*BatchJob, error)
```

--------------------------------

### ImportFileConfig struct

Source: https://pkg.go.dev/google.golang.org/genai

Optional parameters for importing a file.

```go
type ImportFileConfig struct {
	// Optional. Used to override HTTP request options.
	HTTPOptions *HTTPOptions `json:"httpOptions,omitempty"`
	// Optional. User provided custom metadata stored as key-value pairs used for querying.
	CustomMetadata []*CustomMetadata `json:"customMetadata,omitempty"`
	// Optional. Config for telling the service how to chunk the file.
	ChunkingConfig *ChunkingConfig `json:"chunkingConfig,omitempty"`
}
```

--------------------------------

### Tunings.List method

Source: https://pkg.go.dev/google.golang.org/genai

Retrieves a paginated list of tuning job resources.

```go
func (m Tunings) List(ctx context.Context, config *ListTuningJobsConfig) (Page[TuningJob], error)
```

--------------------------------

### DownloadMediaConfig struct

Source: https://pkg.go.dev/google.golang.org/genai

Configuration for overriding HTTP request options when downloading media.

```go
type DownloadMediaConfig struct {
	// Optional. Used to override HTTP request options.
	HTTPOptions *HTTPOptions `json:"httpOptions,omitempty"`
}
```

--------------------------------

### ContextWindowCompressionConfig

Source: https://pkg.go.dev/google.golang.org/genai

Enables context window compression to manage model context window length.

```go
type ContextWindowCompressionConfig struct {
	// Optional. Number of tokens (before running turn) that triggers context window compression
	// mechanism.
	TriggerTokens *int64 `json:"triggerTokens,omitempty,string"`
	// Optional. Sliding window compression mechanism.
	SlidingWindow *SlidingWindow `json:"slidingWindow,omitempty"`
}
```

--------------------------------

### NewContentFromURI

Source: https://pkg.go.dev/google.golang.org/genai

Builds a Content from a file URI and mime type. Defaults to RoleUser if role is empty.

```go
func NewContentFromURI(fileURI, mimeType string, role Role) *Content
```

--------------------------------

### CreateCachedContentConfig struct

Source: https://pkg.go.dev/google.golang.org/genai

Optional configuration for cached content creation.

```go
type CreateCachedContentConfig struct {
	// Optional. Used to override HTTP request options.
	HTTPOptions *HTTPOptions `json:"httpOptions,omitempty"`
	// Optional. The TTL for this resource. The expiration time is computed: now + TTL.
	TTL time.Duration `json:"ttl,omitempty"`
	// Optional. Timestamp of when this resource is considered expired.
	ExpireTime time.Time `json:"expireTime,omitempty"`
	// Optional. The user-generated meaningful display name of the cached content.
	DisplayName string `json:"displayName,omitempty"`
	// Optional. The content to cache.
	Contents []*Content `json:"contents,omitempty"`
	// Optional. Developer set system instruction.
	SystemInstruction *Content `json:"systemInstruction,omitempty"`
	// Optional. A list of `Tools` the model may use to generate the next response.
	Tools []*Tool `json:"tools,omitempty"`
	// Optional. Configuration for the tools to use. This config is shared for all tools.
	ToolConfig *ToolConfig `json:"toolConfig,omitempty"`
	// Optional. The Cloud KMS resource identifier of the customer managed
	// encryption key used to protect a resource.
	// The key needs to be in the same region as where the compute resource is
	// created. See
	// https://cloud.google.com/vertex-ai/docs/general/cmek for more
	// details. If this is set, then all created CachedContent objects
	// will be encrypted with the provided encryption key.
	// Allowed formats: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
	KmsKeyName string `json:"kmsKeyName,omitempty"`
}
```

--------------------------------

### Models.GenerateVideosFromSource method

Source: https://pkg.go.dev/google.golang.org/genai

Creates a long-running video generation operation.

```go
func (m Models) GenerateVideosFromSource(ctx context.Context, model string, source *GenerateVideosSource, config *GenerateVideosConfig) (*GenerateVideosOperation, error)
```

--------------------------------

### ListBatchJobsConfig Struct

Source: https://pkg.go.dev/google.golang.org/genai

Configuration parameters for listing batch jobs.

```go
type ListBatchJobsConfig struct {
	// Optional. Used to override HTTP request options.
	HTTPOptions *HTTPOptions `json:"httpOptions,omitempty"`
	// Optional. PageSize specifies the maximum number of cached contents to return per
	// API call. If zero, the server will use a default value.
	PageSize int32 `json:"pageSize,omitempty"`
	// Optional. PageToken represents a token used for pagination in API responses. It's
	// an opaque string that should be passed to subsequent requests to retrieve the next
	// page of results. An empty PageToken typically indicates that there are no further
	// pages available.
	PageToken string `json:"pageToken,omitempty"`
	// Optional.
	Filter string `json:"filter,omitempty"`
}
```

--------------------------------

### NewPartFromExecutableCode constructor

Source: https://pkg.go.dev/google.golang.org/genai

Builds an ExecutableCode Part from a single piece of source code in the given Language.

```go
func NewPartFromExecutableCode(code string, language Language) *Part
```

--------------------------------

### Files.List method

Source: https://pkg.go.dev/google.golang.org/genai

Retrieves a paginated list of file resources.

```go
func (m Files) List(ctx context.Context, config *ListFilesConfig) (Page[File], error)
```

--------------------------------

### NewContentFromText

Source: https://pkg.go.dev/google.golang.org/genai

Builds a Content from a text string. Defaults to RoleUser if role is empty.

```go
func NewContentFromText(text string, role Role) *Content
```

--------------------------------

### LiveConnectConfig struct definition

Source: https://pkg.go.dev/google.golang.org/genai

Defines the configuration parameters for a live connection, including HTTP options, model behavior settings like temperature and top-k, and specialized configurations for audio, tools, and session resumption.

```go
type LiveConnectConfig struct {
	// Optional. Used to override HTTP request options.
	HTTPOptions *HTTPOptions `json:"httpOptions,omitempty"`
	// Optional. The requested modalities of the response. Represents the set of
	// modalities that the model can return. Defaults to AUDIO if not specified.
	ResponseModalities []Modality `json:"responseModalities,omitempty"`
	// Optional. Value that controls the degree of randomness in token selection.
	// Lower temperatures are good for prompts that require a less open-ended or
	// creative response, while higher temperatures can lead to more diverse or
	// creative results.
	Temperature *float32 `json:"temperature,omitempty"`
	// Optional. Tokens are selected from the most to least probable until the sum
	// of their probabilities equals this value. Use a lower value for less
	// random responses and a higher value for more random responses.
	TopP *float32 `json:"topP,omitempty"`
	// Optional. For each token selection step, the “top_k“ tokens with the
	// highest probabilities are sampled. Then tokens are further filtered based
	// on “top_p“ with the final token selected using temperature sampling. Use
	// a lower number for less random responses and a higher number for more
	// random responses.
	TopK *float32 `json:"topK,omitempty"`
	// Optional. Maximum number of tokens that can be generated in the response.
	// If empty, API will use a default value. The default value varies by model.
	MaxOutputTokens int32 `json:"maxOutputTokens,omitempty"`
	// Optional. If specified, the media resolution specified will be used.
	MediaResolution MediaResolution `json:"mediaResolution,omitempty"`
	// Optional. When “seed“ is fixed to a specific number, the model makes a best
	// effort to provide the same response for repeated requests. By default, a
	// random number is used.
	Seed *int32 `json:"seed,omitempty"`
	// Optional. The speech generation configuration.
	SpeechConfig *SpeechConfig `json:"speechConfig,omitempty"`
	// Optional. Config for thinking features.
	// An error will be returned if this field is set for models that don't
	// support thinking.
	ThinkingConfig *ThinkingConfig `json:"thinkingConfig,omitempty"`
	// Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
	EnableAffectiveDialog *bool `json:"enableAffectiveDialog,omitempty"`
	// Optional. The user provided system instructions for the model.
	// Note: only text should be used in parts and content in each part will be
	// in a separate paragraph.
	SystemInstruction *Content `json:"systemInstruction,omitempty"`
	// Optional. A list of `Tools` the model may use to generate the next response.
	// A `Tool` is a piece of code that enables the system to interact with
	// external systems to perform an action, or set of actions, outside of
	// knowledge and scope of the model.
	Tools []*Tool `json:"tools,omitempty"`
	// Optional. Configures session resumption mechanism.
	// If included the server will send SessionResumptionUpdate messages.
	SessionResumption *SessionResumptionConfig `json:"sessionResumption,omitempty"`
	// Optional. The transcription of the input aligns with the input audio language.
	InputAudioTranscription *AudioTranscriptionConfig `json:"inputAudioTranscription,omitempty"`
	// Optional. The transcription of the output aligns with the language code
	// specified for the output audio.
	OutputAudioTranscription *AudioTranscriptionConfig `json:"outputAudioTranscription,omitempty"`
	// Optional. Configures the realtime input behavior in BidiGenerateContent.
	RealtimeInputConfig *RealtimeInputConfig `json:"realtimeInputConfig,omitempty"`
	// Optional. Configures context window compression mechanism.
	// If included, server will compress context window to fit into given length.
	ContextWindowCompression *ContextWindowCompressionConfig `json:"contextWindowCompression,omitempty"`
	// Optional. Configures the proactivity of the model. This allows the model to respond
	// proactively to
	// the input and to ignore irrelevant input.
	Proactivity *ProactivityConfig `json:"proactivity,omitempty"`
	// Optional. Configures the explicit VAD signal. If enabled, the client will send
	// vad_signal to indicate the start and end of speech. This allows the server
	// to process the audio more efficiently.
	ExplicitVADSignal *bool `json:"explicitVadSignal,omitempty"`
	// Optional. Configures the avatar model behavior.
	AvatarConfig *AvatarConfig `json:"avatarConfig,omitempty"`
	// Optional. Safety settings in the request to block unsafe content in the
	// response.
	SafetySettings []*SafetySetting `json:"safetySettings,omitempty"`
	// Optional. Config for translation.
	TranslationConfig *TranslationConfig `json:"translationConfig,omitempty"`
}
```

--------------------------------

### ListTuningJobsConfig struct

Source: https://pkg.go.dev/google.golang.org/genai

Configuration for the list tuning jobs method.

```go
type ListTuningJobsConfig struct {
	// Optional. Used to override HTTP request options.
	HTTPOptions *HTTPOptions `json:"httpOptions,omitempty"`
	// Optional. PageSize specifies the maximum number of cached contents to return per
	// API call. If zero, the server will use a default value.
	PageSize int32 `json:"pageSize,omitempty"`
	// Optional. PageToken represents a token used for pagination in API responses. It's
	// an opaque string that should be passed to subsequent requests to retrieve the next
	// page of results. An empty PageToken typically indicates that there are no further
	// pages available.
	PageToken string `json:"pageToken,omitempty"`
	// Optional.
	Filter string `json:"filter,omitempty"`
}
```

--------------------------------

### Generate content with multimodal input

Source: https://pkg.go.dev/google.golang.org/genai

Demonstrates how to use the Gemini model to generate text from a combination of text and image input.

```go
parts := []*genai.Part{
  {Text: "What's this image about?"},
  {InlineData: &genai.Blob{Data: imageBytes, MIMEType: "image/jpeg"}},
}
result, err := client.Models.GenerateContent(ctx, "gemini-2.5-flash", []*genai.Content{{Parts: parts}}, nil)
```

--------------------------------

### GetDocumentConfig struct

Source: https://pkg.go.dev/google.golang.org/genai

Optional configuration for document retrieval.

```go
type GetDocumentConfig struct {
	// Optional. Used to override HTTP request options.
	HTTPOptions *HTTPOptions `json:"httpOptions,omitempty"`
}
```

--------------------------------

### Models.GenerateImages method

Source: https://pkg.go.dev/google.golang.org/genai

Generates images based on the provided model, prompt, and configuration.

```go
func (m Models) GenerateImages(ctx context.Context, model string, prompt string, config *GenerateImagesConfig) (*GenerateImagesResponse, error)
```

--------------------------------

### ActivityHandling type and constants

Source: https://pkg.go.dev/google.golang.org/genai

Defines the different ways of handling user activity.

```go
type ActivityHandling string
```

```go
const (
	// If unspecified, the default behavior is `START_OF_ACTIVITY_INTERRUPTS`.
	ActivityHandlingUnspecified ActivityHandling = "ACTIVITY_HANDLING_UNSPECIFIED"
	// If true, start of activity will interrupt the model's response (also called "barge
	// in"). The model's current response will be cut-off in the moment of the interruption.
	// This is the default behavior.
	ActivityHandlingStartOfActivityInterrupts ActivityHandling = "START_OF_ACTIVITY_INTERRUPTS"
	// The model's response will not be interrupted.
	ActivityHandlingNoInterruption ActivityHandling = "NO_INTERRUPTION"
)
```

--------------------------------

### Retrieve all models with All

Source: https://pkg.go.dev/google.golang.org/genai

Retrieves all model resources using internal pagination. Returns an iterator yielding each entry.

```go
func (m Models) All(ctx context.Context) iter.Seq2[*Model, error]
```

--------------------------------

### RealtimeInputConfig struct

Source: https://pkg.go.dev/google.golang.org/genai

Configuration for realtime input, including activity detection and turn coverage settings. This marks the end of user activity and can only be sent if server-side activity detection is disabled.

```go
type RealtimeInputConfig struct {
	// Optional. If not set, automatic activity detection is enabled by default. If automatic
	// voice detection is disabled, the client must send activity signals.
	AutomaticActivityDetection *AutomaticActivityDetection `json:"automaticActivityDetection,omitempty"`
	// Optional. Defines what effect activity has.
	ActivityHandling ActivityHandling `json:"activityHandling,omitempty"`
	// Optional. Defines which input is included in the user's turn.
	TurnCoverage TurnCoverage `json:"turnCoverage,omitempty"`
}
```

--------------------------------

### FileSearchStores ImportFile method

Source: https://pkg.go.dev/google.golang.org/genai

Imports a file into a FileSearchStore.

```go
func (m FileSearchStores) ImportFile(ctx context.Context, fileSearchStoreName string, fileName string, config *ImportFileConfig) (*ImportFileOperation, error)
```

--------------------------------

### Caches.All method

Source: https://pkg.go.dev/google.golang.org/genai

Retrieves all cached content resources using an iterator, handling pagination internally.

```go
func (m Caches) All(ctx context.Context) iter.Seq2[*CachedContent, error]
```
Tokens:
Raw