Google Gen AI SDK

https://googleapis.github.io/js-genai/
Admin
The Google Gen AI JavaScript SDK enables TypeScript and JavaScript developers to build applications...
Tokens:233,950
Snippets:4,630
Trust Score:8.3
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Generate content with API key

Source: https://googleapis.github.io/js-genai/release_docs/index.html

Quickstart example that generates content using an API key from Google AI Studio. The API key is read from the GEMINI_API_KEY environment variable.

```javascript
import {GoogleGenAI} from '@google/genai';  
const GEMINI_API_KEY = process.env.GEMINI_API_KEY;  
  
const ai = new GoogleGenAI({apiKey: GEMINI_API_KEY});  
  
async function main() {  
  const response = await ai.models.generateContent({  
    model: 'gemini-flash-latest',  
    contents: 'Why is the sky blue?',  
  });  
  console.log(response.text);  
}  
  
main();
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/tunings.Tunings.html

Gets a TuningJob. This method is experimental.

```APIDOC
## get(params: GetTuningJobParameters): Promise<TuningJob>

### Description
`Experimental` Gets a TuningJob.

### Parameters
- **params** (GetTuningJobParameters) - Required - The parameters for the get request.

### Returns
- **Promise<TuningJob>** - A TuningJob object. The SDK's tuning implementation is experimental, and may change in future versions.
```

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

### get model example

Source: https://googleapis.github.io/js-genai/release_docs/classes/models.Models.html

Fetches information about a model by name.

```javascript
const modelInfo = await ai.models.get({model: 'gemini-2.0-flash'});
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/filesearchstores.FileSearchStores.html

Gets a File Search Store.

```APIDOC
## get(params: GetFileSearchStoreParameters): Promise<FileSearchStore>

### Description
Gets a File Search Store.

### Parameters
- **params** (GetFileSearchStoreParameters) - Required - The parameters for getting a File Search Store.

### Returns
- **Promise<FileSearchStore>** - FileSearchStore.
```

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

### Install @google/genai

Source: https://googleapis.github.io/js-genai/release_docs/index.html

Installs the Google Gen AI SDK for Node.js. Requires Node.js version 20 or later.

```bash
npm install @google/genai
```

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

### Connect to a live session with callbacks

Source: https://googleapis.github.io/js-genai/release_docs/classes/live.Live.html

Example from the connect method documentation. It selects a model based on the GOOGLE_GENAI_USE_VERTEXAI environment variable, then calls ai.live.connect with responseModalities set to AUDIO and defines callbacks for socket open, message, error, and close events. The example logs messages and errors using a debug function.

```typescript
let model: string;  
if (GOOGLE_GENAI_USE_VERTEXAI) {  
  model = 'gemini-2.0-flash-live-preview-04-09';  
} else {  
  model = 'gemini-live-2.5-flash-preview';  
}  
const session = await ai.live.connect({  
  model: model,  
  config: {  
    responseModalities: [Modality.AUDIO],  
  },  
  callbacks: {  
    onopen: () => {  
      console.log('Connected to the socket.');  
    },  
    onmessage: (e: MessageEvent) => {  
      console.log('Received message from the server: %s\n', debug(e.data));  
    },  
    onerror: (e: ErrorEvent) => {  
      console.log('Error occurred: %s\n', debug(e.error));  
    },  
    onclose: (e: CloseEvent) => {  
      console.log('Connection closed.');  
    },  
  },  
});
```

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

### play

Source: https://googleapis.github.io/js-genai/release_docs/classes/music.LiveMusicSession.html

Starts the music stream.

```APIDOC
## play

### Description
Starts the music stream.

### Method
play

### Parameters
None

### Returns
void
```

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

### create(properties?: ISample): Sample

Source: https://googleapis.github.io/js-genai/release_docs/classes/cross_sentencepiece_sentencepiece_model.pb.sentencepiece.SelfTestData.Sample.html

Creates a new Sample instance using the specified properties.

```APIDOC
## create(properties?: ISample): Sample

### Description
Creates a new Sample instance using the specified properties.

### Method
Static create

### Parameters
- **properties** (ISample) - Optional - Properties to set

### Returns
Sample - Sample instance

```

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

### Get file information

Source: https://googleapis.github.io/js-genai/release_docs/classes/files.Files.html

Retrieves file information from the service. The example uses GetFileParameters and logs the file name.

```typescript
const config: GetFileParameters = {  
  name: fileName,  
};  
file = await ai.files.get(config);  
console.log(file.name);
```

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

### new Sample(properties?: ISample): Sample

Source: https://googleapis.github.io/js-genai/release_docs/classes/cross_sentencepiece_sentencepiece_model.pb.sentencepiece.SelfTestData.Sample.html

Constructs a new Sample instance with optional properties.

```APIDOC
## new Sample(properties?: ISample): Sample

### Description
Constructs a new Sample instance.

### Method
constructor

### Parameters
- **properties** (ISample) - Optional - Properties to set

### Returns
Sample

```

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

### Run a Deep Research agent and poll for results

Source: https://googleapis.github.io/js-genai/release_docs/index.html

Use the Deep Research agent 'deep-research-pro-preview-12-2025' for complex tasks. The example starts the agent in the background and polls until the interaction completes, fails, or is cancelled.

```typescript
function sleep(ms: number): Promise<void> {  
  return new Promise(resolve => setTimeout(resolve, ms));  
}  
  
// 1. Start the Deep Research Agent  
const initialInteraction = await ai.interactions.create({  
  input:  
      'Research the history of the Google TPUs with a focus on 2025 and 2026.',  
  agent: 'deep-research-pro-preview-12-2025',  
  background: true,  
});  
  
console.log(`Research started. Interaction ID: ${initialInteraction.id}`);  
  
// 2. Poll for results  
while (true) {  
  const interaction = await ai.interactions.get(initialInteraction.id);  
  console.log(`Status: ${interaction.status}`);  
  
  if (interaction.status === 'completed') {  
    console.debug('\nFinal Report:\n', interaction.outputs);  
    break;  
  } else if (['failed', 'cancelled'].includes(interaction.status)) {  
    console.log(`Failed with status: ${interaction.status}`);  
    break;  
  }  
  
  await sleep(10000);  // Sleep for 10 seconds  
}
```

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

### Live.constructor

Source: https://googleapis.github.io/js-genai/release_docs/classes/live.Live.html

Creates a new Live instance with the provided API client, authentication, and WebSocket factory.

```APIDOC
## Live.constructor

### Description
Creates a new Live instance.

### Method
constructor

### Parameters
- **apiClient** (ApiClient) - Required - The API client for general API settings.
- **auth** (Auth) - Required - The authentication object.
- **webSocketFactory** (WebSocketFactory) - Required - The WebSocket factory.

### Returns
Live
```

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

### sdkInit

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_hooks_hooks.SDKHooks.html

Executes all registered SDK initialization hooks with the given options. Returns the possibly modified SDK options.

```APIDOC
## SDKHooks.sdkInit

### Description
Executes all registered SDK initialization hooks with the given options. Returns the possibly modified SDK options.

### Method
`sdkInit`

### Parameters
- `opts` (SDKOptions) - Required - The SDK options.

### Returns
`SDKOptions`
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/documents.Documents.html

Gets a Document.

```APIDOC
## get(params: GetDocumentParameters): Promise<Document>

### Description
Gets a Document.

### Parameters
- **params** (GetDocumentParameters) - Required - The parameters for getting a document.

### Returns
Promise<Document> - A promise that resolves with the Document.
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_sdk_credentials.Credentials.html

Gets a credential by ID.

```APIDOC
## get(id: string, params?: GetCredentialParams, options?: Omit<RequestOptions, "extra_body">): APIPromise<Credential>

### Description
Gets a credential by ID.

### Parameters
- **id** (string) - Required - The ID of the credential to retrieve.
- **params** (GetCredentialParams) - Optional - Additional parameters for retrieval.
- **options** (Omit<RequestOptions, "extra_body">) - Optional - Request options.

### Returns
APIPromise<Credential>
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_sdk_agents.Agents.html

Gets a specific Agent.

```APIDOC
## get(id: string, params?: GetAgentParams, options?: Omit<RequestOptions, "extra_body">): APIPromise<Agent>

### Description
Gets a specific Agent.

### Method
get

### Parameters
- **id** (string) - Required - The ID of the agent to retrieve.
- **params** (GetAgentParams) - Optional - Additional parameters for retrieval.
- **options** (Omit<RequestOptions, "extra_body">) - Optional - Additional request options.

### Returns
APIPromise<Agent>
```

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

### LiveClientSetup

Source: https://googleapis.github.io/js-genai/release_docs/interfaces/types.LiveClientSetup.html

Interface defining the configuration for a live streaming session. It includes optional properties for avatar, context window compression, VAD signal, generation config, history, audio transcription, labels, model, proactivity, realtime input, safety settings, session resumption, system instruction, and tools.

```APIDOC
## Interface LiveClientSetup

### Description
Message contains configuration that will apply for the duration of the streaming session.

### Properties

#### `Optional` avatarConfig
- **Type**: `AvatarConfig`
- **Description**: Configures the avatar model behavior.

#### `Optional` contextWindowCompression
- **Type**: `ContextWindowCompressionConfig`
- **Description**: Configures context window compression mechanism. If included, server will compress context window to fit into given length.

#### `Optional` explicitVadSignal
- **Type**: `boolean`
- **Description**: 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.

#### `Optional` generationConfig
- **Type**: `GenerationConfig`
- **Description**: The generation configuration for the session. Note: only a subset of fields are supported.

#### `Optional` historyConfig
- **Type**: `HistoryConfig`
- **Description**: Configures the exchange of history between the client and the server.

#### `Optional` inputAudioTranscription
- **Type**: `AudioTranscriptionConfig`
- **Description**: The transcription of the input aligns with the input audio language.

#### `Optional` labels
- **Type**: `Record<string, string>`
- **Description**: Optional. Labels with user-defined metadata for the request. Labels must follow standard unified Cloud label requirements: Label keys must start with a letter. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Usage: Safety identifiers from aggregators: Use the key `safety_identifier` (e.g. `{"safety_identifier": "user_session_123"}`)

#### `Optional` model
- **Type**: `string`
- **Description**: The fully qualified name of the publisher model or tuned model endpoint to use.

#### `Optional` outputAudioTranscription
- **Type**: `AudioTranscriptionConfig`
- **Description**: The transcription of the output aligns with the language code specified for the output audio.

#### `Optional` proactivity
- **Type**: `ProactivityConfig`
- **Description**: Configures the proactivity of the model. This allows the model to respond proactively to the input and to ignore irrelevant input.

#### `Optional` realtimeInputConfig
- **Type**: `RealtimeInputConfig`
- **Description**: Configures the realtime input behavior in BidiGenerateContent.

#### `Optional` safetySettings
- **Type**: `SafetySetting[]`
- **Description**: Safety settings in the request to block unsafe content in the response.

#### `Optional` sessionResumption
- **Type**: `SessionResumptionConfig`
- **Description**: Configures session resumption mechanism. If included server will send SessionResumptionUpdate messages.

#### `Optional` systemInstruction
- **Type**: `ContentUnion`
- **Description**: 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.

#### `Optional` tools
- **Type**: `ToolListUnion`
- **Description**: 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.
```

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

### create

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_google-genai.GeminiNextGenEnvironments.html

Creates a new environment.

```APIDOC
## create

### Description
Creates a new environment using the provided request parameters.

### Method
create

### Signature
`create(params: CreateEnvironmentRequest & { api_version?: string }, options?: GoogleGenAIRequestOptions): Promise<Environment>`

### Parameters
- **params** (CreateEnvironmentRequest & { api_version?: string }) - Required - The request parameters for creating an environment.
- **options** (GoogleGenAIRequestOptions) - Optional - Additional request options.

### Returns
- **Promise<Environment>** - A promise that resolves to the created environment.
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_sdk_triggers.Triggers.html

Gets details of a single trigger.

```APIDOC
## get

### Description
Gets details of a single trigger.

### Method
get

### Signature
get(id: string, params?: GetTriggerParams, options?: Omit<RequestOptions, "extra_body">): APIPromise<Trigger>

### Parameters
- **id** (string) - Required - The ID of the trigger to retrieve.
- **params** (GetTriggerParams) - Optional - Additional parameters for getting the trigger.
- **options** (Omit<RequestOptions, "extra_body">) - Optional - Request options.

### Returns
APIPromise<Trigger>
```

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

### constructor

Source: https://googleapis.github.io/js-genai/release_docs/classes/music.LiveMusic.html

Constructor for the LiveMusic class, initializing it with the required dependencies.

```APIDOC
## [constructor] new LiveMusic(apiClient, auth, webSocketFactory)

### Description
Creates a new instance of the LiveMusic class with the provided API client, authentication, and WebSocket factory.

### Method
constructor

### Parameters
- **apiClient** (ApiClient) - Required - The API client used for making requests.
- **auth** (Auth) - Required - The authentication object for authorized access.
- **webSocketFactory** (WebSocketFactory) - Required - Factory for creating WebSocket connections.

### Returns
LiveMusic - A new LiveMusic instance.
```

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

### constructor

Source: https://googleapis.github.io/js-genai/release_docs/classes/music.LiveMusicSession.html

Creates a new LiveMusicSession instance with the provided WebSocket connection and API client.

```APIDOC
## constructor

### Description
Creates a new LiveMusicSession instance.

### Method
constructor

### Parameters
- **conn** (WebSocket) - Required - The WebSocket connection to the API.
- **apiClient** (ApiClient) - Required - The API client used for making requests.

### Returns
LiveMusicSession
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/operations.Operations.html

Gets the status of a long-running operation. This method is generic and can be used for any operation type.

```APIDOC
## get

### Description
Gets the status of a long-running operation.

### Method
GET

### Endpoint
Not applicable (SDK method)

### Parameters
#### Type Parameters
- **T** - The type of the operation result.
- **U extends Operation<T>** - The operation type.

#### Parameters
- **parameters** (OperationGetParameters<T, U>) - Required - The parameters for the get operation request.

### Returns
Promise<Operation<T>> - The updated Operation object, with the latest status or result.

```

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

### constructor

Source: https://googleapis.github.io/js-genai/release_docs/classes/files.Files.html

Creates a new Files instance with the provided ApiClient.

```APIDOC
## new Files(apiClient: ApiClient): Files

### Description
Creates a new Files instance.

### Parameters
- **apiClient** (ApiClient) - Required - The API client used for making requests.

### Returns
- **Files** - A new Files instance.
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/caches.Caches.html

Gets cached content configurations. This method is part of the Caches class in the @google/genai SDK.

```APIDOC
## get(params: GetCachedContentParameters): Promise<CachedContent>

### Description
Gets cached content configurations.

### Parameters
- **params** (GetCachedContentParameters) - Required - The parameters for the get request.

### Returns
- **Promise<CachedContent>** - The cached content.

### Example
```
await ai.caches.get({name: '...'}); // The server-generated resource name.
```
```

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

### Live.connect

Source: https://googleapis.github.io/js-genai/release_docs/classes/live.Live.html

Establishes a connection to the specified model with the given configuration and returns a Session object representing that connection.

```APIDOC
## Live.connect

### Description
Establishes a connection to the specified model with the given configuration and returns a Session object representing that connection. Built-in MCP support is an experimental feature, may change in future versions.

### Method
connect

### Parameters
- **params** (LiveConnectParameters) - Required - The parameters for establishing a connection to the model.

### Returns
Promise<Session> - A live session.

### Example
```
let model: string;  
if (GOOGLE_GENAI_USE_VERTEXAI) {  
  model = 'gemini-2.0-flash-live-preview-04-09';  
} else {  
  model = 'gemini-live-2.5-flash-preview';  
}  
const session = await ai.live.connect({  
  model: model,  
  config: {  
    responseModalities: [Modality.AUDIO],  
  },  
  callbacks: {  
    onopen: () => {  
      console.log('Connected to the socket.');  
    },  
    onmessage: (e: MessageEvent) => {  
      console.log('Received message from the server: %s\n', debug(e.data));  
    },  
    onerror: (e: ErrorEvent) => {  
      console.log('Error occurred: %s\n', debug(e.error));  
    },  
    onclose: (e: CloseEvent) => {  
      console.log('Connection closed.');  
    },  
  },  
});
```
```

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

### Get cached content configurations

Source: https://googleapis.github.io/js-genai/release_docs/classes/caches.Caches.html

Gets cached content configurations using the server-generated resource name.

```typescript
await ai.caches.get({name: '...'}); // The server-generated resource name.
```

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

### create

Source: https://googleapis.github.io/js-genai/release_docs/classes/filesearchstores.FileSearchStores.html

Creates a File Search Store.

```APIDOC
## create(params: CreateFileSearchStoreParameters): Promise<FileSearchStore>

### Description
Creates a File Search Store.

### Parameters
- **params** (CreateFileSearchStoreParameters) - Required - The parameters for creating a File Search Store.

### Returns
- **Promise<FileSearchStore>** - FileSearchStore.
```

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

### Initialize SDK for Vertex AI API

Source: https://googleapis.github.io/js-genai/release_docs/classes/client.GoogleGenAI.html

Initializes the Google GenAI SDK for the Vertex AI API. Requires GoogleGenAIOptions.project and GoogleGenAIOptions.location.

```typescript
import {GoogleGenAI} from '@google/genai';  
const ai = new GoogleGenAI({  
  vertexai: true,  
  project: 'PROJECT_ID',  
  location: 'PROJECT_LOCATION'  
});
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_sdk_voices.Voices.html

Gets a custom stored voice by resource name. Prebuilt catalog voices cannot be retrieved via this method.

```APIDOC
## get

### Description
Gets a custom stored voice (`store = true`) by resource name. Prebuilt catalog voices (`VOICE_TYPE_PREBUILT`) cannot be retrieved via `GetVoice`; use `ListVoices` instead.

### Method
get

### Parameters
- **id** (string) - Required - The resource name of the voice to retrieve.
- **params** (GetVoiceParams) - Optional - Additional parameters for the get operation.
- **options** (Omit<RequestOptions, "extra_body">) - Optional - Additional request options.

### Returns
APIPromise<VoiceOutput>
```

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

### Get a batch job

Source: https://googleapis.github.io/js-genai/release_docs/classes/batches.Batches.html

Gets batch job configurations using the server-generated resource name. The name is a placeholder.

```javascript
await ai.batches.get({name: '...'}); // The server-generated resource name.
```

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

### list

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_google-genai.GeminiNextGenEnvironmentFiles.html

Lists environment files and returns a response containing the list of files.

```APIDOC
## list

### Description
Lists environment files and returns a response containing the list of files.

### Signature
```typescript
list(
  params: GetEnvironmentFilesRequest,
  options?: GoogleGenAIRequestOptions,
): Promise<GetEnvironmentFilesResponse>
```

### Parameters
- `params` (GetEnvironmentFilesRequest) - Required - The request parameters for listing environment files.
- `options` (GoogleGenAIRequestOptions) - Optional - Additional request options.

### Returns
- `Promise<GetEnvironmentFilesResponse>` - A promise that resolves to the response containing the list of environment files.
```

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

### Initialize for Gemini Enterprise Agent Platform

Source: https://googleapis.github.io/js-genai/release_docs/index.html

Initializes the client for Gemini Enterprise Agent Platform. Requires enterprise: true, project, and location.

```javascript
import { GoogleGenAI } from '@google/genai';  
  
const ai = new GoogleGenAI({  
    enterprise: true,  
    project: 'your_project',  
    location: 'your_location',  
});
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_sdk_webhooks.Webhooks.html

Gets a specific Webhook by its ID. Accepts an id string, optional GetWebhookParams, and optional RequestOptions, returning an APIPromise<Webhook>.

```APIDOC
## get

### Description
Gets a specific Webhook.

### Method
get

### Signature
get(id: string, params?: GetWebhookParams, options?: Omit<RequestOptions, "extra_body">): APIPromise<Webhook>

### Parameters
- **id** (string) - Required - The ID of the webhook to retrieve.
- **params** (GetWebhookParams) - Optional - Additional parameters.
- **options** (Omit<RequestOptions, "extra_body">) - Optional - Request options.

### Returns
APIPromise<Webhook>
```

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

### get(params: GetBatchJobParameters): Promise<BatchJob>

Source: https://googleapis.github.io/js-genai/release_docs/classes/batches.Batches.html

Gets batch job configurations. Accepts a GetBatchJobParameters object containing the resource name of the batch job to retrieve.

```APIDOC
## get(params: GetBatchJobParameters): Promise<BatchJob>

### Description
Gets batch job configurations.

### Parameters
- **params** (GetBatchJobParameters) - Required - The parameters for the get request.

### Returns
Promise<BatchJob> - The batch job.

### Example
```
await ai.batches.get({name: '...'}); // The server-generated resource name.
```
```

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

### create

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_google-genai.GeminiNextGenWebhooks.html

Creates a new webhook with the provided input parameters.

```APIDOC
## create

### Description
Creates a new webhook with the provided input parameters.

### Method
create

### Parameters
- **params** (WebhookInput & { api_version?: string }) - Required - The webhook configuration and optional API version.
- **options** (GoogleGenAIRequestOptions) - Optional - Request options.

### Returns
Promise<Webhook>
```

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

### List documents with page size

Source: https://googleapis.github.io/js-genai/release_docs/classes/documents.Documents.html

Example usage of the list method to retrieve documents with a page size of 2. The example uses ai.documents.list with a parent parameter and iterates over the returned pager to log each document.

```javascript
const documents = await ai.documents.list({parent:'rag_store_name', config: {'pageSize': 2}});  
for await (const document of documents) {  
  console.log(document);  
}
```

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

### List files

Source: https://googleapis.github.io/js-genai/release_docs/classes/files.Files.html

Lists files with pagination. The example lists files with a page size of 2 and logs each file.

```typescript
const files = await ai.files.list({config: {'pageSize': 2}});  
for await (const file of files) {  
  console.log(file);  
}
```

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

### credentialsGet

Source: https://googleapis.github.io/js-genai/release_docs/functions/gaos_funcs_credentials-get.credentialsGet.html

Gets a credential by ID.

```APIDOC
## credentialsGet(client, id, api_version?, options?)

### Description
Gets a credential by ID.

### Parameters
- **client** (GoogleGenAICore) - Required - The client instance.
- **id** (string) - Required - The ID of the credential to retrieve.
- **api_version** (string) - Optional - The API version to use.
- **options** (Omit<RequestOptions, "extra_body">) - Optional - Additional request options.

### Returns
APIPromise<Result<Credential, UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError | GoogleGenAiError>>
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_google-genai.GeminiNextGenVoices.html

Retrieves a voice by its ID.

```APIDOC
## get

### Description
Gets a voice resource by its identifier.

### Method
get

### Parameters
- **id** (string) - Required - The ID of the voice to retrieve.
- **params** (undefined | null | GetVoiceParams) - Optional - Additional parameters for the get operation. Defaults to {}.
- **options** (GoogleGenAIRequestOptions) - Optional - Request options.

### Returns
Promise<VoiceOutput>
```

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

### constructor

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_google-genai.GeminiNextGenEnvironments.html

Creates a new instance of GeminiNextGenEnvironments with a parent client.

```APIDOC
## constructor

### Description
Creates a new GeminiNextGenEnvironments instance.

### Signature
`new GeminiNextGenEnvironments(parentClient: GoogleGenAIParentClient): GeminiNextGenEnvironments`

### Parameters
- **parentClient** (GoogleGenAIParentClient) - Required - The parent client used for initialization.

### Returns
- **GeminiNextGenEnvironments** - The new instance.
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_google-genai.GeminiNextGenWebhooks.html

Retrieves a webhook by its ID.

```APIDOC
## get

### Description
Retrieves a webhook by its ID.

### Method
get

### Parameters
- **id** (string) - Required - The ID of the webhook to retrieve.
- **params** (undefined | null | { api_version?: string }) - Optional - Optional API version parameter.
- **options** (GoogleGenAIRequestOptions) - Optional - Request options.

### Returns
Promise<Webhook>
```

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

### new ReinforcementTuningParseResponseConfig()

Source: https://googleapis.github.io/js-genai/release_docs/classes/types.ReinforcementTuningParseResponseConfig.html

Creates a new instance of ReinforcementTuningParseResponseConfig.

```APIDOC
## Constructor

### Description
Creates a new instance of ReinforcementTuningParseResponseConfig.

### Method
constructor

### Signature
new ReinforcementTuningParseResponseConfig(): ReinforcementTuningParseResponseConfig

### Returns
ReinforcementTuningParseResponseConfig
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_google-genai.GeminiNextGenEnvironments.html

Retrieves an environment by its ID.

```APIDOC
## get

### Description
Gets an environment identified by the given ID.

### Method
get

### Signature
`get(id: string, params?: undefined | null | { api_version?: string }, options?: GoogleGenAIRequestOptions): Promise<Environment>`

### Parameters
- **id** (string) - Required - The ID of the environment to retrieve.
- **params** (undefined | null | { api_version?: string }) - Optional - Additional parameters, defaults to {}.
- **options** (GoogleGenAIRequestOptions) - Optional - Additional request options.

### Returns
- **Promise<Environment>** - A promise that resolves to the environment.
```

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

### Configure environment variables for enterprise

Source: https://googleapis.github.io/js-genai/release_docs/index.html

Sets environment variables for Gemini Enterprise Agent Platform and then creates a client without explicit configuration. The client reads GOOGLE_GENAI_USE_ENTERPRISE, GOOGLE_CLOUD_PROJECT, and GOOGLE_CLOUD_LOCATION.

```bash
export GOOGLE_GENAI_USE_ENTERPRISE=true  
export GOOGLE_CLOUD_PROJECT='your-project-id'  
export GOOGLE_CLOUD_LOCATION='us-central1'
```

```javascript
import {GoogleGenAI} from '@google/genai';  
  
const ai = new GoogleGenAI();
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_google-genai.GeminiNextGenTriggers.html

Retrieves a trigger by ID.

```APIDOC
## get(id: string, params?: undefined | null | GetTriggerParams, options?: GoogleGenAIRequestOptions): Promise<Trigger>

### Description
Retrieves a trigger by its ID.

### Method
get

### Parameters
- **id** (string) - Required - The ID of the trigger to retrieve.
- **params** (GetTriggerParams) - Optional - Additional parameters for retrieval.
- **options** (GoogleGenAIRequestOptions) - Optional - Request options.

### Returns
- **Promise<Trigger>** - A promise that resolves to the retrieved Trigger.
```

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

### constructor

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_google-genai.GeminiNextGenEnvironmentFiles.html

Creates a new instance of GeminiNextGenEnvironmentFiles with the provided client resolver and optional parent client.

```APIDOC
## constructor

### Description
Creates a new instance of GeminiNextGenEnvironmentFiles.

### Signature
```typescript
new GeminiNextGenEnvironmentFiles(
  resolveClient: (apiVersion?: string) => GoogleGenAI,
  parentClient?: GoogleGenAIParentClient,
): GeminiNextGenEnvironmentFiles
```

### Parameters
- `resolveClient` (function) - Required - A function that resolves a GoogleGenAI client, optionally taking an API version string.
- `parentClient` (GoogleGenAIParentClient) - Optional - The parent client instance.

### Returns
- `GeminiNextGenEnvironmentFiles` - A new instance of the class.
```

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

### generateVideos example

Source: https://googleapis.github.io/js-genai/release_docs/classes/models.Models.html

Generates videos asynchronously. The operation is polled every 10 seconds until done, then the video URI is printed.

```javascript
const operation = await ai.models.generateVideos({  
 model: 'veo-2.0-generate-001',  
 source: {  
   prompt: 'A neon hologram of a cat driving at top speed',  
 },  
 config: {  
   numberOfVideos: 1  
});  
  
while (!operation.done) {  
  await new Promise(resolve => setTimeout(resolve, 10000));  
  operation = await ai.operations.getVideosOperation({operation: operation});  
}  
  
console.log(operation.response?.generatedVideos?.[0]?.video?.uri);
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_google-genai.GeminiNextGenCredentials.html

Retrieves a credential by its ID.

```APIDOC
## get

### Description
Retrieves a credential by its ID.

### Method
get

### Parameters
- **id** (string) - Required - The ID of the credential to retrieve.
- **params** (undefined | null | { api_version?: string }) - Optional - Additional parameters, defaults to {}.
- **options** (GoogleGenAIRequestOptions) - Optional - Additional request options.

### Returns
Promise<Credential>
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/models.Models.html

Fetches information about a model by name.

```APIDOC
## get

### Description
Fetches information about a model by name.

### Method
SDK Method

### Endpoint
`get(params: GetModelParameters): Promise<Model>`

### Parameters
#### Parameters
- **params** (GetModelParameters) - Required - The parameters for getting a model.

### Returns
Promise<Model> - The model information.

### Example
```
const modelInfo = await ai.models.get({model: 'gemini-2.0-flash'});
```
```

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

### Initialize SDK for Gemini API

Source: https://googleapis.github.io/js-genai/release_docs/classes/client.GoogleGenAI.html

Initializes the Google GenAI SDK for the Gemini API. Requires a GoogleGenAIOptions.apiKey.

```typescript
import {GoogleGenAI} from '@google/genai';  
const ai = new GoogleGenAI({apiKey: 'GEMINI_API_KEY'});
```

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

### get

Source: https://googleapis.github.io/js-genai/release_docs/classes/files.Files.html

Retrieves the file information from the service.

```APIDOC
## get(params: GetFileParameters): Promise<File>

### Description
Retrieves the file information from the service.

### Parameters
- **params** (GetFileParameters) - Required - The parameters for the get request.

### Returns
- **Promise<File>** - The Promise that resolves to the types.File object requested.

### Example
```
const config: GetFileParameters = {  
  name: fileName,  
};  
file = await ai.files.get(config);  
console.log(file.name);
```
```

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

### CreateTuningJobParameters

Source: https://googleapis.github.io/js-genai/release_docs/interfaces/types.CreateTuningJobParameters.html

Interface for fine-tuning job creation parameters.

```APIDOC
## CreateTuningJobParameters

### Description
Fine-tuning job creation parameters - optional fields.

### Properties
- **baseModel** (string) - Required - The base model that is being tuned, e.g., "gemini-2.5-flash".
- **config** (CreateTuningJobConfig) - Optional - Configuration for the tuning job.
- **trainingDataset** (TuningDataset) - Required - Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.

```

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

### _getUnwrapped

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_types_async.APIPromise.html

Internal method to get the unwrapped promise.

```APIDOC
## _getUnwrapped()

### Description
Returns a promise that resolves to the unwrapped data value.

### Method
_getUnwrapped

### Returns
Promise<T>
```

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

### getReader

Source: https://googleapis.github.io/js-genai/release_docs/classes/gaos_lib_event-streams.Stream.html

Gets a reader for the stream, either BYOB or default.

```APIDOC
## getReader

### Description
Gets a reader for the stream, either BYOB or default.

### Method
getReader

### Signatures
1. getReader(options: { mode: "byob" }): ReadableStreamBYOBReader
2. getReader(): ReadableStreamDefaultReader<T>
3. getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReader<T>

### Parameters
- **options** ({ mode: "byob" }) - Required for BYOB reader - Options to request a BYOB reader.
- **options** (ReadableStreamGetReaderOptions) - Optional - Options for getting a reader.

### Returns
- ReadableStreamBYOBReader
- ReadableStreamDefaultReader<T>
- ReadableStreamReader<T>
```
Tokens:
Raw