init: vibn-agent-runner — Gemini autonomous agent backend
Made-with: Cursor
This commit is contained in:
202
node_modules/@google/genai/LICENSE
generated
vendored
Normal file
202
node_modules/@google/genai/LICENSE
generated
vendored
Normal file
@@ -0,0 +1,202 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
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.
|
||||
609
node_modules/@google/genai/README.md
generated
vendored
Normal file
609
node_modules/@google/genai/README.md
generated
vendored
Normal file
@@ -0,0 +1,609 @@
|
||||
# Google Gen AI SDK for TypeScript and JavaScript
|
||||
|
||||
[](https://www.npmjs.com/package/@google/genai)
|
||||
[](https://www.npmjs.com/package/@google/genai)
|
||||
|
||||
----------------------
|
||||
**Documentation:** https://googleapis.github.io/js-genai/
|
||||
|
||||
----------------------
|
||||
|
||||
The Google Gen AI JavaScript SDK is designed for
|
||||
TypeScript and JavaScript developers to build applications powered by Gemini. The SDK
|
||||
supports both the [Gemini Developer API](https://ai.google.dev/gemini-api/docs)
|
||||
and [Vertex AI](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview).
|
||||
|
||||
The Google Gen AI SDK is designed to work with Gemini 2.0+ features.
|
||||
|
||||
> [!CAUTION]
|
||||
> **API Key Security:** Avoid exposing API keys in client-side code.
|
||||
> Use server-side implementations in production environments.
|
||||
|
||||
## Code Generation
|
||||
|
||||
Generative models are often unaware of recent API and SDK updates and may suggest outdated or legacy code.
|
||||
|
||||
We recommend using our Code Generation instructions [`codegen_instructions.md`](https://raw.githubusercontent.com/googleapis/js-genai/refs/heads/main/codegen_instructions.md) when generating Google Gen AI SDK code to guide your model towards using the more recent SDK features. Copy and paste the instructions into your development environment to provide the model with the necessary context.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. Node.js version 20 or later
|
||||
|
||||
### The following are required for Vertex AI users (excluding Vertex AI Studio)
|
||||
1. [Select](https://console.cloud.google.com/project) or [create](https://cloud.google.com/resource-manager/docs/creating-managing-projects#creating_a_project) a Google Cloud project.
|
||||
1. [Enable billing for your project](https://cloud.google.com/billing/docs/how-to/modify-project).
|
||||
1. [Enable the Vertex AI API](https://console.cloud.google.com/flows/enableapi?apiid=aiplatform.googleapis.com).
|
||||
1. [Configure authentication](https://cloud.google.com/docs/authentication) for your project.
|
||||
* [Install the gcloud CLI](https://cloud.google.com/sdk/docs/install).
|
||||
* [Initialize the gcloud CLI](https://cloud.google.com/sdk/docs/initializing).
|
||||
* Create local authentication credentials for your user account:
|
||||
|
||||
```sh
|
||||
gcloud auth application-default login
|
||||
```
|
||||
A list of accepted authentication options are listed in [GoogleAuthOptions](https://github.com/googleapis/google-auth-library-nodejs/blob/3ae120d0a45c95e36c59c9ac8286483938781f30/src/auth/googleauth.ts#L87) interface of google-auth-library-node.js GitHub repo.
|
||||
|
||||
## Installation
|
||||
|
||||
To install the SDK, run the following command:
|
||||
|
||||
```shell
|
||||
npm install @google/genai
|
||||
```
|
||||
|
||||
## Quickstart
|
||||
|
||||
The simplest way to get started is to use an API key from
|
||||
[Google AI Studio](https://aistudio.google.com/apikey):
|
||||
|
||||
```typescript
|
||||
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-2.5-flash',
|
||||
contents: 'Why is the sky blue?',
|
||||
});
|
||||
console.log(response.text);
|
||||
}
|
||||
|
||||
main();
|
||||
```
|
||||
|
||||
## Initialization
|
||||
|
||||
The Google Gen AI SDK provides support for both the
|
||||
[Google AI Studio](https://ai.google.dev/gemini-api/docs) and
|
||||
[Vertex AI](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview)
|
||||
implementations of the Gemini API.
|
||||
|
||||
### Gemini Developer API
|
||||
|
||||
For server-side applications, initialize using an API key, which can
|
||||
be acquired from [Google AI Studio](https://aistudio.google.com/apikey):
|
||||
|
||||
```typescript
|
||||
import { GoogleGenAI } from '@google/genai';
|
||||
const ai = new GoogleGenAI({apiKey: 'GEMINI_API_KEY'});
|
||||
```
|
||||
|
||||
#### Browser
|
||||
|
||||
> [!CAUTION]
|
||||
> **API Key Security:** Avoid exposing API keys in client-side code.
|
||||
> Use server-side implementations in production environments.
|
||||
|
||||
In the browser the initialization code is identical:
|
||||
|
||||
|
||||
```typescript
|
||||
import { GoogleGenAI } from '@google/genai';
|
||||
const ai = new GoogleGenAI({apiKey: 'GEMINI_API_KEY'});
|
||||
```
|
||||
|
||||
### Vertex AI
|
||||
|
||||
Sample code for VertexAI initialization:
|
||||
|
||||
```typescript
|
||||
import { GoogleGenAI } from '@google/genai';
|
||||
|
||||
const ai = new GoogleGenAI({
|
||||
vertexai: true,
|
||||
project: 'your_project',
|
||||
location: 'your_location',
|
||||
});
|
||||
```
|
||||
|
||||
### (Optional) (NodeJS only) Using environment variables:
|
||||
|
||||
For NodeJS environments, you can create a client by configuring the necessary
|
||||
environment variables. Configuration setup instructions depends on whether
|
||||
you're using the Gemini Developer API or the Gemini API in Vertex AI.
|
||||
|
||||
**Gemini Developer API:** Set `GOOGLE_API_KEY` as shown below:
|
||||
|
||||
```bash
|
||||
export GOOGLE_API_KEY='your-api-key'
|
||||
```
|
||||
|
||||
**Gemini API on Vertex AI:** Set `GOOGLE_GENAI_USE_VERTEXAI`,
|
||||
`GOOGLE_CLOUD_PROJECT` and `GOOGLE_CLOUD_LOCATION`, as shown below:
|
||||
|
||||
```bash
|
||||
export GOOGLE_GENAI_USE_VERTEXAI=true
|
||||
export GOOGLE_CLOUD_PROJECT='your-project-id'
|
||||
export GOOGLE_CLOUD_LOCATION='us-central1'
|
||||
```
|
||||
|
||||
```typescript
|
||||
import {GoogleGenAI} from '@google/genai';
|
||||
|
||||
const ai = new GoogleGenAI();
|
||||
```
|
||||
|
||||
## API Selection
|
||||
|
||||
By default, the SDK uses the beta API endpoints provided by Google to support
|
||||
preview features in the APIs. The stable API endpoints can be selected by
|
||||
setting the API version to `v1`.
|
||||
|
||||
To set the API version use `apiVersion`. For example, to set the API version to
|
||||
`v1` for Vertex AI:
|
||||
|
||||
```typescript
|
||||
const ai = new GoogleGenAI({
|
||||
vertexai: true,
|
||||
project: 'your_project',
|
||||
location: 'your_location',
|
||||
apiVersion: 'v1'
|
||||
});
|
||||
```
|
||||
|
||||
To set the API version to `v1alpha` for the Gemini Developer API:
|
||||
|
||||
```typescript
|
||||
const ai = new GoogleGenAI({
|
||||
apiKey: 'GEMINI_API_KEY',
|
||||
apiVersion: 'v1alpha'
|
||||
});
|
||||
```
|
||||
|
||||
## GoogleGenAI overview
|
||||
|
||||
All API features are accessed through an instance of the `GoogleGenAI` classes.
|
||||
The submodules bundle together related API methods:
|
||||
|
||||
- [`ai.models`](https://googleapis.github.io/js-genai/release_docs/classes/models.Models.html):
|
||||
Use `models` to query models (`generateContent`, `generateImages`, ...), or
|
||||
examine their metadata.
|
||||
- [`ai.caches`](https://googleapis.github.io/js-genai/release_docs/classes/caches.Caches.html):
|
||||
Create and manage `caches` to reduce costs when repeatedly using the same
|
||||
large prompt prefix.
|
||||
- [`ai.chats`](https://googleapis.github.io/js-genai/release_docs/classes/chats.Chats.html):
|
||||
Create local stateful `chat` objects to simplify multi turn interactions.
|
||||
- [`ai.files`](https://googleapis.github.io/js-genai/release_docs/classes/files.Files.html):
|
||||
Upload `files` to the API and reference them in your prompts.
|
||||
This reduces bandwidth if you use a file many times, and handles files too
|
||||
large to fit inline with your prompt.
|
||||
- [`ai.live`](https://googleapis.github.io/js-genai/release_docs/classes/live.Live.html):
|
||||
Start a `live` session for real time interaction, allows text + audio + video
|
||||
input, and text or audio output.
|
||||
|
||||
## Samples
|
||||
|
||||
More samples can be found in the
|
||||
[github samples directory](https://github.com/googleapis/js-genai/tree/main/sdk-samples).
|
||||
|
||||
### Streaming
|
||||
|
||||
For quicker, more responsive API interactions use the `generateContentStream`
|
||||
method which yields chunks as they're generated:
|
||||
|
||||
```typescript
|
||||
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.generateContentStream({
|
||||
model: 'gemini-2.5-flash',
|
||||
contents: 'Write a 100-word poem.',
|
||||
});
|
||||
for await (const chunk of response) {
|
||||
console.log(chunk.text);
|
||||
}
|
||||
}
|
||||
|
||||
main();
|
||||
```
|
||||
|
||||
### Function Calling
|
||||
|
||||
To let Gemini to interact with external systems, you can provide
|
||||
`functionDeclaration` objects as `tools`. To use these tools it's a 4 step
|
||||
|
||||
1. **Declare the function name, description, and parametersJsonSchema**
|
||||
2. **Call `generateContent` with function calling enabled**
|
||||
3. **Use the returned `FunctionCall` parameters to call your actual function**
|
||||
3. **Send the result back to the model (with history, easier in `ai.chat`)
|
||||
as a `FunctionResponse`**
|
||||
|
||||
```typescript
|
||||
import {GoogleGenAI, FunctionCallingConfigMode, FunctionDeclaration, Type} from '@google/genai';
|
||||
const GEMINI_API_KEY = process.env.GEMINI_API_KEY;
|
||||
|
||||
async function main() {
|
||||
const controlLightDeclaration: FunctionDeclaration = {
|
||||
name: 'controlLight',
|
||||
parametersJsonSchema: {
|
||||
type: 'object',
|
||||
properties:{
|
||||
brightness: {
|
||||
type:'number',
|
||||
},
|
||||
colorTemperature: {
|
||||
type:'string',
|
||||
},
|
||||
},
|
||||
required: ['brightness', 'colorTemperature'],
|
||||
},
|
||||
};
|
||||
|
||||
const ai = new GoogleGenAI({apiKey: GEMINI_API_KEY});
|
||||
const response = await ai.models.generateContent({
|
||||
model: 'gemini-2.5-flash',
|
||||
contents: 'Dim the lights so the room feels cozy and warm.',
|
||||
config: {
|
||||
toolConfig: {
|
||||
functionCallingConfig: {
|
||||
// Force it to call any function
|
||||
mode: FunctionCallingConfigMode.ANY,
|
||||
allowedFunctionNames: ['controlLight'],
|
||||
}
|
||||
},
|
||||
tools: [{functionDeclarations: [controlLightDeclaration]}]
|
||||
}
|
||||
});
|
||||
|
||||
console.log(response.functionCalls);
|
||||
}
|
||||
|
||||
main();
|
||||
```
|
||||
|
||||
#### Model Context Protocol (MCP) support (experimental)
|
||||
|
||||
Built-in [MCP](https://modelcontextprotocol.io/introduction) support is an
|
||||
experimental feature. You can pass a local MCP server as a tool directly.
|
||||
|
||||
```javascript
|
||||
import { GoogleGenAI, FunctionCallingConfigMode , mcpToTool} from '@google/genai';
|
||||
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
|
||||
import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";
|
||||
|
||||
// Create server parameters for stdio connection
|
||||
const serverParams = new StdioClientTransport({
|
||||
command: "npx", // Executable
|
||||
args: ["-y", "@philschmid/weather-mcp"] // MCP Server
|
||||
});
|
||||
|
||||
const client = new Client(
|
||||
{
|
||||
name: "example-client",
|
||||
version: "1.0.0"
|
||||
}
|
||||
);
|
||||
|
||||
// Configure the client
|
||||
const ai = new GoogleGenAI({});
|
||||
|
||||
// Initialize the connection between client and server
|
||||
await client.connect(serverParams);
|
||||
|
||||
// Send request to the model with MCP tools
|
||||
const response = await ai.models.generateContent({
|
||||
model: "gemini-2.5-flash",
|
||||
contents: `What is the weather in London in ${new Date().toLocaleDateString()}?`,
|
||||
config: {
|
||||
tools: [mcpToTool(client)], // uses the session, will automatically call the tool using automatic function calling
|
||||
},
|
||||
});
|
||||
console.log(response.text);
|
||||
|
||||
// Close the connection
|
||||
await client.close();
|
||||
```
|
||||
|
||||
### Generate Content
|
||||
|
||||
#### How to structure `contents` argument for `generateContent`
|
||||
|
||||
The SDK allows you to specify the following types in the `contents` parameter:
|
||||
|
||||
#### Content
|
||||
|
||||
- `Content`: The SDK will wrap the singular `Content` instance in an array which
|
||||
contains only the given content instance
|
||||
- `Content[]`: No transformation happens
|
||||
|
||||
#### Part
|
||||
|
||||
Parts will be aggregated on a singular Content, with role 'user'.
|
||||
|
||||
- `Part | string`: The SDK will wrap the `string` or `Part` in a `Content`
|
||||
instance with role 'user'.
|
||||
- `Part[] | string[]`: The SDK will wrap the full provided list into a single
|
||||
`Content` with role 'user'.
|
||||
|
||||
**_NOTE:_** This doesn't apply to `FunctionCall` and `FunctionResponse` parts,
|
||||
if you are specifying those, you need to explicitly provide the full
|
||||
`Content[]` structure making it explicit which Parts are 'spoken' by the model,
|
||||
or the user. The SDK will throw an exception if you try this.
|
||||
|
||||
## Error Handling
|
||||
|
||||
To handle errors raised by the API, the SDK provides this [ApiError](https://github.com/googleapis/js-genai/blob/main/src/errors.ts) class.
|
||||
|
||||
```typescript
|
||||
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() {
|
||||
await ai.models.generateContent({
|
||||
model: 'non-existent-model',
|
||||
contents: 'Write a 100-word poem.',
|
||||
}).catch((e) => {
|
||||
console.error('error name: ', e.name);
|
||||
console.error('error message: ', e.message);
|
||||
console.error('error status: ', e.status);
|
||||
});
|
||||
}
|
||||
|
||||
main();
|
||||
```
|
||||
|
||||
## Interactions (Preview)
|
||||
|
||||
> **Warning:** The Interactions API is in **Beta**. This is a preview of an
|
||||
experimental feature. Features and schemas are subject to **breaking changes**.
|
||||
|
||||
The Interactions API is a unified interface for interacting with Gemini models
|
||||
and agents. It simplifies state management, tool orchestration, and long-running
|
||||
tasks.
|
||||
|
||||
See the [documentation site](https://ai.google.dev/gemini-api/docs/interactions)
|
||||
for more details.
|
||||
|
||||
### Basic Interaction
|
||||
|
||||
```typescript
|
||||
const interaction = await ai.interactions.create({
|
||||
model: 'gemini-2.5-flash',
|
||||
input: 'Hello, how are you?',
|
||||
});
|
||||
console.debug(interaction);
|
||||
|
||||
```
|
||||
|
||||
### Stateful Conversation
|
||||
|
||||
The Interactions API supports server-side state management. You can continue a
|
||||
conversation by referencing the `previous_interaction_id`.
|
||||
|
||||
```typescript
|
||||
// 1. First turn
|
||||
const interaction1 = await ai.interactions.create({
|
||||
model: 'gemini-2.5-flash',
|
||||
input: 'Hi, my name is Amir.',
|
||||
});
|
||||
console.debug(interaction1);
|
||||
|
||||
// 2. Second turn (passing previous_interaction_id)
|
||||
const interaction2 = await ai.interactions.create({
|
||||
model: 'gemini-2.5-flash',
|
||||
input: 'What is my name?',
|
||||
previous_interaction_id: interaction1.id,
|
||||
});
|
||||
console.debug(interaction2);
|
||||
|
||||
```
|
||||
|
||||
### Agents (Deep Research)
|
||||
|
||||
You can use specialized agents like `deep-research-pro-preview-12-2025` for
|
||||
complex tasks.
|
||||
|
||||
```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
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
### Multimodal Input
|
||||
|
||||
You can provide multimodal data (text, images, audio, etc.) in the input list.
|
||||
|
||||
```typescript
|
||||
import base64
|
||||
|
||||
// Assuming you have a base64 string
|
||||
// const base64Image = ...;
|
||||
|
||||
const interaction = await ai.interactions.create({
|
||||
model: 'gemini-2.5-flash',
|
||||
input: [
|
||||
{ type: 'text', text: 'Describe the image.' },
|
||||
{ type: 'image', data: base64Image, mime_type: 'image/png' },
|
||||
],
|
||||
});
|
||||
|
||||
console.debug(interaction);
|
||||
|
||||
```
|
||||
|
||||
### Function Calling
|
||||
|
||||
You can define custom functions for the model to use. The Interactions API
|
||||
handles the tool selection, and you provide the execution result back to the
|
||||
model.
|
||||
|
||||
```typescript
|
||||
// 1. Define the tool
|
||||
const getWeather = (location: string) => {
|
||||
/* Gets the weather for a given location. */
|
||||
return `The weather in ${location} is sunny.`;
|
||||
};
|
||||
|
||||
// 2. Send the request with tools
|
||||
let interaction = await ai.interactions.create({
|
||||
model: 'gemini-2.5-flash',
|
||||
input: 'What is the weather in Mountain View, CA?',
|
||||
tools: [
|
||||
{
|
||||
type: 'function',
|
||||
name: 'get_weather',
|
||||
description: 'Gets the weather for a given location.',
|
||||
parameters: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
location: {
|
||||
type: 'string',
|
||||
description: 'The city and state, e.g. San Francisco, CA',
|
||||
},
|
||||
},
|
||||
required: ['location'],
|
||||
},
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
// 3. Handle the tool call
|
||||
for (const output of interaction.outputs!) {
|
||||
if (output.type === 'function_call') {
|
||||
console.log(
|
||||
`Tool Call: ${output.name}(${JSON.stringify(output.arguments)})`);
|
||||
|
||||
// Execute your actual function here
|
||||
// Note: ensure arguments match your function signature
|
||||
const result = getWeather(JSON.stringify(output.arguments.location));
|
||||
|
||||
// Send result back to the model
|
||||
interaction = await ai.interactions.create({
|
||||
model: 'gemini-2.5-flash',
|
||||
previous_interaction_id: interaction.id,
|
||||
input: [
|
||||
{
|
||||
type: 'function_result',
|
||||
name: output.name,
|
||||
call_id: output.id,
|
||||
result: result,
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
console.debug(`Response: ${JSON.stringify(interaction)}`);
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
### Built-in Tools
|
||||
You can also use Google's built-in tools, such as **Google Search** or **Code
|
||||
Execution**.
|
||||
|
||||
#### Grounding with Google Search
|
||||
|
||||
```typescript
|
||||
const interaction = await ai.interactions.create({
|
||||
model: 'gemini-2.5-flash',
|
||||
input: 'Who won the last Super Bowl',
|
||||
tools: [{ type: 'google_search' }],
|
||||
});
|
||||
|
||||
console.debug(interaction);
|
||||
|
||||
```
|
||||
|
||||
#### Code Execution
|
||||
|
||||
```typescript
|
||||
const interaction = await ai.interactions.create({
|
||||
model: 'gemini-2.5-flash',
|
||||
input: 'Calculate the 50th Fibonacci number.',
|
||||
tools: [{ type: 'code_execution' }],
|
||||
});
|
||||
|
||||
console.debug(interaction);
|
||||
|
||||
```
|
||||
|
||||
### Multimodal Output
|
||||
|
||||
The Interactions API can generate multimodal outputs, such as images. You must
|
||||
specify the `response_modalities`.
|
||||
|
||||
```typescript
|
||||
import * as fs from 'fs';
|
||||
|
||||
const interaction = await ai.interactions.create({
|
||||
model: 'gemini-3-pro-image-preview',
|
||||
input: 'Generate an image of a futuristic city.',
|
||||
response_modalities: ['image'],
|
||||
});
|
||||
|
||||
for (const output of interaction.outputs!) {
|
||||
if (output.type === 'image') {
|
||||
console.log(`Generated image with mime_type: ${output.mime_type}`);
|
||||
// Save the image
|
||||
fs.writeFileSync(
|
||||
'generated_city.png', Buffer.from(output.data!, 'base64'));
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## How is this different from the other Google AI SDKs
|
||||
This SDK (`@google/genai`) is Google Deepmind’s "vanilla" SDK for its generative
|
||||
AI offerings, and is where Google Deepmind adds new AI features.
|
||||
|
||||
Models hosted either on the [Vertex AI platform](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview) or the [Gemini Developer platform](https://ai.google.dev/gemini-api/docs) are accessible through this SDK.
|
||||
|
||||
Other SDKs may be offering additional AI frameworks on top of this SDK, or may
|
||||
be targeting specific project environments (like Firebase).
|
||||
|
||||
The `@google/generative_language` and `@google-cloud/vertexai` SDKs are previous
|
||||
iterations of this SDK and are no longer receiving new Gemini 2.0+ features.
|
||||
11409
node_modules/@google/genai/dist/genai.d.ts
generated
vendored
Normal file
11409
node_modules/@google/genai/dist/genai.d.ts
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
19884
node_modules/@google/genai/dist/index.cjs
generated
vendored
Normal file
19884
node_modules/@google/genai/dist/index.cjs
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
19807
node_modules/@google/genai/dist/index.mjs
generated
vendored
Normal file
19807
node_modules/@google/genai/dist/index.mjs
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
1
node_modules/@google/genai/dist/index.mjs.map
generated
vendored
Normal file
1
node_modules/@google/genai/dist/index.mjs.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
20372
node_modules/@google/genai/dist/node/index.cjs
generated
vendored
Normal file
20372
node_modules/@google/genai/dist/node/index.cjs
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
20275
node_modules/@google/genai/dist/node/index.mjs
generated
vendored
Normal file
20275
node_modules/@google/genai/dist/node/index.mjs
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
1
node_modules/@google/genai/dist/node/index.mjs.map
generated
vendored
Normal file
1
node_modules/@google/genai/dist/node/index.mjs.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
11421
node_modules/@google/genai/dist/node/node.d.ts
generated
vendored
Normal file
11421
node_modules/@google/genai/dist/node/node.d.ts
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
5708
node_modules/@google/genai/dist/tokenizer/node.cjs
generated
vendored
Normal file
5708
node_modules/@google/genai/dist/tokenizer/node.cjs
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
1213
node_modules/@google/genai/dist/tokenizer/node.d.ts
generated
vendored
Normal file
1213
node_modules/@google/genai/dist/tokenizer/node.d.ts
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
5684
node_modules/@google/genai/dist/tokenizer/node.mjs
generated
vendored
Normal file
5684
node_modules/@google/genai/dist/tokenizer/node.mjs
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
1
node_modules/@google/genai/dist/tokenizer/node.mjs.map
generated
vendored
Normal file
1
node_modules/@google/genai/dist/tokenizer/node.mjs.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
19862
node_modules/@google/genai/dist/web/index.mjs
generated
vendored
Normal file
19862
node_modules/@google/genai/dist/web/index.mjs
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
1
node_modules/@google/genai/dist/web/index.mjs.map
generated
vendored
Normal file
1
node_modules/@google/genai/dist/web/index.mjs.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
11414
node_modules/@google/genai/dist/web/web.d.ts
generated
vendored
Normal file
11414
node_modules/@google/genai/dist/web/web.d.ts
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
4
node_modules/@google/genai/node/package.json
generated
vendored
Normal file
4
node_modules/@google/genai/node/package.json
generated
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"name": "@google/genai/node",
|
||||
"main": "../dist/node/index.js"
|
||||
}
|
||||
167
node_modules/@google/genai/package.json
generated
vendored
Normal file
167
node_modules/@google/genai/package.json
generated
vendored
Normal file
@@ -0,0 +1,167 @@
|
||||
{
|
||||
"name": "@google/genai",
|
||||
"version": "1.43.0",
|
||||
"description": "",
|
||||
"type": "module",
|
||||
"main": "dist/node/index.mjs",
|
||||
"module": "dist/web/index.mjs",
|
||||
"browser": "dist/web/index.mjs",
|
||||
"typings": "dist/genai.d.ts",
|
||||
"exports": {
|
||||
".": {
|
||||
"browser": {
|
||||
"types": "./dist/web/web.d.ts",
|
||||
"import": "./dist/web/index.mjs",
|
||||
"default": "./dist/web/index.mjs"
|
||||
},
|
||||
"node": {
|
||||
"types": "./dist/node/node.d.ts",
|
||||
"import": "./dist/node/index.mjs",
|
||||
"require": "./dist/node/index.cjs",
|
||||
"default": "./dist/node/index.mjs"
|
||||
},
|
||||
"types": "./dist/genai.d.ts",
|
||||
"import": "./dist/index.mjs",
|
||||
"require": "./dist/index.cjs",
|
||||
"default": "./dist/index.mjs"
|
||||
},
|
||||
"./web": {
|
||||
"types": "./dist/web/web.d.ts",
|
||||
"import": "./dist/web/index.mjs",
|
||||
"default": "./dist/web/index.mjs"
|
||||
},
|
||||
"./node": {
|
||||
"types": "./dist/node/node.d.ts",
|
||||
"import": "./dist/node/index.mjs",
|
||||
"default": "./dist/node/index.mjs"
|
||||
},
|
||||
"./tokenizer": {
|
||||
"node": {
|
||||
"types": "./dist/tokenizer/node.d.ts",
|
||||
"import": "./dist/tokenizer/node.mjs",
|
||||
"require": "./dist/tokenizer/node.cjs",
|
||||
"default": "./dist/tokenizer/node.mjs"
|
||||
},
|
||||
"types": "./dist/tokenizer/node.d.ts",
|
||||
"import": "./dist/tokenizer/node.mjs",
|
||||
"require": "./dist/tokenizer/node.cjs",
|
||||
"default": "./dist/tokenizer/node.mjs"
|
||||
},
|
||||
"./tokenizer/node": {
|
||||
"types": "./dist/tokenizer/node.d.ts",
|
||||
"import": "./dist/tokenizer/node.mjs",
|
||||
"require": "./dist/tokenizer/node.cjs",
|
||||
"default": "./dist/tokenizer/node.mjs"
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"prepare": "node scripts/prepare.js",
|
||||
"build": "patch-package && rollup -c && npm-run-all --parallel api-extractor:dev:* && node scripts/ignore_missing_mcp_dep.js",
|
||||
"build-prod": "patch-package && rollup -c && npm-run-all --parallel api-extractor:prod:* && node scripts/ignore_missing_mcp_dep.js",
|
||||
"api-extractor:dev:main": "api-extractor run --local --verbose",
|
||||
"api-extractor:dev:node": "api-extractor run -c api-extractor.node.json --local --verbose",
|
||||
"api-extractor:dev:web": "api-extractor run -c api-extractor.web.json --local --verbose",
|
||||
"api-extractor:dev:tokenizer-node": "api-extractor run -c api-extractor.tokenizer-node.json --local --verbose",
|
||||
"api-extractor:prod:main": "api-extractor run --verbose",
|
||||
"api-extractor:prod:node": "api-extractor run -c api-extractor.node.json --verbose",
|
||||
"api-extractor:prod:web": "api-extractor run -c api-extractor.web.json --verbose",
|
||||
"api-extractor:prod:tokenizer-node": "api-extractor run -c api-extractor.tokenizer-node.json --verbose",
|
||||
"unit-test": "tsc && cp src/cross/sentencepiece/sentencepiece_model.pb.js dist/src/cross/sentencepiece/ && jasmine dist/test/unit/**/*_test.js dist/test/unit/**/**/*_test.js dist/test/unit/*_test.js",
|
||||
"system-test": "tsc && jasmine dist/test/system/**/*_test.js",
|
||||
"test-server-tests": "tsc && GOOGLE_CLOUD_PROJECT=googcloudproj GOOGLE_CLOUD_LOCATION=googcloudloc jasmine dist/test/system/node/*_test.js -- --test-server",
|
||||
"test-server-tests:record": "tsc && jasmine --fail-fast dist/test/system/node/*_test.js -- --test-server --record",
|
||||
"docs": "typedoc && node --loader ts-node/esm scripts/add_docsite_license_headers.ts",
|
||||
"pages-main": "node --loader ts-node/esm scripts/generate_pages.ts main",
|
||||
"pages-release": "node --loader ts-node/esm scripts/generate_pages.ts release",
|
||||
"format": "prettier '**/*.ts' '**/*.mjs' '**/*.json' --write",
|
||||
"lint": "eslint '**/*.ts'",
|
||||
"lint-fix": "eslint --fix '**/*.ts'",
|
||||
"coverage-report": "./test/generate_report.sh",
|
||||
"generate-proto": "pbjs -t static-module -w es6 -o src/cross/sentencepiece/sentencepiece_model.pb.js src/cross/sentencepiece/sentencepiece_model.proto && pbts -o src/cross/sentencepiece/sentencepiece_model.pb.d.ts src/cross/sentencepiece/sentencepiece_model.pb.js && sed -i.bak 's/import \\* as \\$protobuf from \"protobufjs\\/minimal\"/import \\$protobuf from \"protobufjs\\/minimal.js\"/' src/cross/sentencepiece/sentencepiece_model.pb.js && rm src/cross/sentencepiece/sentencepiece_model.pb.js.bak"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=20.0.0"
|
||||
},
|
||||
"overrides": {
|
||||
"tmp": "^0.2.4"
|
||||
},
|
||||
"files": [
|
||||
"dist/genai.d.ts",
|
||||
"dist/index.mjs",
|
||||
"dist/index.cjs",
|
||||
"dist/index.mjs.map",
|
||||
"dist/node/index.mjs",
|
||||
"dist/node/index.cjs",
|
||||
"dist/node/index.mjs.map",
|
||||
"dist/node/node.d.ts",
|
||||
"dist/web/index.mjs",
|
||||
"dist/web/index.mjs.map",
|
||||
"dist/web/web.d.ts",
|
||||
"dist/tokenizer/node.mjs",
|
||||
"dist/tokenizer/node.cjs",
|
||||
"dist/tokenizer/node.mjs.map",
|
||||
"dist/tokenizer/node.d.ts",
|
||||
"node/package.json",
|
||||
"web/package.json"
|
||||
],
|
||||
"devDependencies": {
|
||||
"@cfworker/json-schema": "^4.1.1",
|
||||
"@eslint/js": "9.20.0",
|
||||
"@microsoft/api-extractor": "^7.52.9",
|
||||
"@modelcontextprotocol/sdk": "^1.25.2",
|
||||
"@rollup/plugin-json": "^6.1.0",
|
||||
"@types/jasmine": "^5.1.2",
|
||||
"@types/node": "^20.9.0",
|
||||
"@types/node-fetch": "^2.6.13",
|
||||
"@types/unist": "^3.0.3",
|
||||
"@types/ws": "^8.5.14",
|
||||
"c8": "^10.1.3",
|
||||
"eslint": "8.57.0",
|
||||
"gts": "^5.2.0",
|
||||
"jasmine": "^5.5.0",
|
||||
"jasmine-reporters": "^2.4.0",
|
||||
"node-fetch": "^3.3.2",
|
||||
"npm-run-all": "^4.1.5",
|
||||
"nyc": "^17.1.0",
|
||||
"patch-package": "^8.0.1",
|
||||
"prettier": "3.3.3",
|
||||
"prettier-plugin-organize-imports": "^4.1.0",
|
||||
"protobufjs-cli": "^1.1.3",
|
||||
"rollup-plugin-typescript2": "^0.36.0",
|
||||
"test-server-sdk": "^0.2.9",
|
||||
"ts-node": "^10.9.2",
|
||||
"tslib": "^2.8.1",
|
||||
"tsx": "^4.19.4",
|
||||
"typedoc": "^0.27.0",
|
||||
"typescript": "~5.4.0",
|
||||
"typescript-eslint": "8.24.1",
|
||||
"undici": "^7.16.0",
|
||||
"undici-types": "^7.16.0",
|
||||
"zod": "^3.25.0",
|
||||
"zod-to-json-schema": "^3.25.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"google-auth-library": "^10.3.0",
|
||||
"p-retry": "^4.6.2",
|
||||
"protobufjs": "^7.5.4",
|
||||
"ws": "^8.18.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@modelcontextprotocol/sdk": "^1.25.2"
|
||||
},
|
||||
"peerDependenciesMeta": {
|
||||
"@modelcontextprotocol/sdk": {
|
||||
"optional": true
|
||||
}
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/googleapis/js-genai.git"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/googleapis/js-genai/issues"
|
||||
},
|
||||
"homepage": "https://github.com/googleapis/js-genai#readme",
|
||||
"author": "",
|
||||
"license": "Apache-2.0"
|
||||
}
|
||||
4
node_modules/@google/genai/web/package.json
generated
vendored
Normal file
4
node_modules/@google/genai/web/package.json
generated
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"name": "@google/genai/web",
|
||||
"module": "../dist/web/index.mjs"
|
||||
}
|
||||
Reference in New Issue
Block a user