generative-ai-js Documentation

Technical Documentation: google-gemini/generative-ai-js

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

[Deprecated] Google AI JavaScript SDK for the Gemini API

With Gemini 2.0, we took the chance to create a single unified SDK for all developers who want to use Google's GenAI models (Gemini, Veo, Imagen, etc). As part of that process, we took all of the feedback from this SDK and what developers like about other SDKs in the ecosystem to create the Google Gen AI SDK.

The full migration guide from the old SDK to new SDK is available in the Gemini API docs.

The Gemini API docs are fully updated to show examples of the new Google Gen AI SDK. We know how disruptive an SDK change can be and don't take this change lightly, but our goal is to create an extremely simple and clear path for developers to build with our models so it felt necessary to make this change.

Thank you for building with Gemini and let us know if you need any help!

Please be advised that this repository is now considered legacy. For the latest features, performance improvements, and active development, we strongly recommend migrating to the official Google Generative AI SDK for JavaScript.

Support Plan for this Repository:

• Limited Maintenance: Development is now restricted to critical bug fixes only. No new features will be added.
• Purpose: This limited support aims to provide stability for users while they transition to the new SDK.
• End-of-Life Date: All support for this repository (including bug fixes) will permanently end on November 30, 2025.

We encourage all users to begin planning their migration to the Google Generative AI SDK to ensure continued access to the latest capabilities and support.

Overview (`samples/README.md`) Copy Section

Google Generative AI Samples for JavaScript

These samples demonstrate how to use state-of-the-art
generative AI models (like Gemini) to build AI-powered features and applications.

To try out these samples, you'll need Node.js v18+.

For some samples of how to adapt this to web, see the web/ subdirectory.

Requirements Copy Chapter

Follow the instructions on Google AI Studio setup page to obtain an API key.

It’s strongly recommended that you do not check an API key into your version control system. Instead, you should use a secrets store for your API key.

This sample assumes that you're providing an API_KEY environment variable.

Instructions Copy Chapter

Each of these sample files can be run in Node.js from the command line, for
example:

node function_calling.js

Some of these files run multiple example cases sequentially, and you may want
to comment out cases you do not want to run.

Documentation Copy Chapter

• Quickstart: Get started with the Gemini API in Node.js applications

Contents Copy Chapter

Overview (`samples/web/README.md`) Copy Section

Google Generative AI Sample for Web (Javascript)

This sample app demonstrates how to use state-of-the-art
generative AI models (like Gemini) to build AI-powered features and applications.

To try out this sample app, you'll need a modern web browser and a local http server.

Requirements Copy Chapter

Follow the instructions on Google AI Studio setup page to obtain an API key.

It’s strongly recommended that you do not check an API key into your version control system. Instead, you should use a secrets store for your API key.

The Node.js http server provided alonside this app (http-server.js) assumes that you're providing an API_KEY environment variable.

Features Copy Chapter

This sample showcases the following API capablilites:

• index.html - demonstrates the Text and MultiModal feature from the SDK
• chat.html - demonstrates the Multi-turn Conversations feature from the SDK

Documentation Copy Chapter

• Quickstart: Get started with the Gemini API in web apps

Reference Files Index (`docs/reference/files/index.md`) Copy Section

Home

API Reference Copy Chapter

Packages Copy Chapter

Reference Main Generative Ai.Citationsource.Endindex (`docs/reference/main/generative-ai.citationsource.endindex.md`) Copy Section

Home > @google/generative-ai > CitationSource > endIndex

CitationSource.endIndex property Copy Chapter

Signature:

endIndex?: number;

Reference Main Generative Ai.Citationsource.Startindex (`docs/reference/main/generative-ai.citationsource.startindex.md`) Copy Section

Home > @google/generative-ai > CitationSource > startIndex

CitationSource.startIndex property Copy Chapter

Signature:

startIndex?: number;

Reference Main Generative Ai.Generatecontentcandidate.Index (`docs/reference/main/generative-ai.generatecontentcandidate.index.md`) Copy Section

Home > @google/generative-ai > GenerateContentCandidate > index

GenerateContentCandidate.index property Copy Chapter

Signature:

index: number;

Reference Main Generative Ai.Groundingsupportsegment.Endindex (`docs/reference/main/generative-ai.groundingsupportsegment.endindex.md`) Copy Section

Home > @google/generative-ai > GroundingSupportSegment > endIndex

GroundingSupportSegment.endIndex property Copy Chapter

End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.

Signature:

endIndex?: number;

Reference Main Generative Ai.Groundingsupportsegment.Partindex (`docs/reference/main/generative-ai.groundingsupportsegment.partindex.md`) Copy Section

Home > @google/generative-ai > GroundingSupportSegment > partIndex

GroundingSupportSegment.partIndex property Copy Chapter

The index of a Part object within its parent Content object.

Signature:

partIndex?: number;

Reference Main Generative Ai.Groundingsupportsegment.Startindex (`docs/reference/main/generative-ai.groundingsupportsegment.startindex.md`) Copy Section

Home > @google/generative-ai > GroundingSupportSegment > startIndex

GroundingSupportSegment.startIndex property Copy Chapter

Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.

Signature:

startIndex?: number;

Reference Main Index (`docs/reference/main/index.md`) Copy Section

Home

API Reference Copy Chapter

Packages Copy Chapter

Reference Server Index (`docs/reference/server/index.md`) Copy Section

Home

API Reference Copy Chapter

Packages Copy Chapter

Code Of Conduct (`docs/code-of-conduct.md`) Copy Section

Code of Conduct

Our Pledge Copy Chapter

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of
experience, education, socio-economic status, nationality, personal appearance,
race, religion, or sexual identity and orientation.

Our Standards Copy Chapter

Examples of behavior that contributes to creating a positive environment
include:

• Using welcoming and inclusive language
• Being respectful of differing viewpoints and experiences
• Gracefully accepting constructive criticism
• Focusing on what is best for the community
• Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

• The use of sexualized language or imagery and unwelcome sexual attention or
  advances
• Trolling, insulting/derogatory comments, and personal or political attacks
• Public or private harassment
• Publishing others' private information, such as a physical or electronic
  address, without explicit permission
• Other conduct which could reasonably be considered inappropriate in a
  professional setting

Our Responsibilities Copy Chapter

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, or to ban temporarily or permanently any
contributor for other behaviors that they deem inappropriate, threatening,
offensive, or harmful.

Scope Copy Chapter

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

This Code of Conduct also applies outside the project spaces when the Project
Steward has a reasonable belief that an individual's behavior may have a
negative impact on the project or its community.

Conflict Resolution Copy Chapter

We do not believe that all conflict is bad; healthy debate and disagreement
often yield positive results. However, it is never okay to be disrespectful or
to engage in behavior that violates the project’s code of conduct.

If you see someone violating the code of conduct, you are encouraged to address
the behavior directly with those involved. Many issues can be resolved quickly
and easily, and this gives people more control over the outcome of their
dispute. If you are unable to resolve the matter for any reason, or if the
behavior is threatening or harassing, report it. We are dedicated to providing
an environment where participants feel welcome and safe.

Reports should be directed to [PROJECT STEWARD NAME(s) AND EMAIL(s)], the
Project Steward(s) for [PROJECT NAME]. It is the Project Steward’s duty to
receive and address reported violations of the code of conduct. They will then
work with a committee consisting of representatives from the Open Source
Programs Office and the Google Open Source Strategy team. If for any reason you
are uncomfortable reaching out to the Project Steward, please email
[email protected].

We will investigate every complaint, but you may not receive a direct response.
We will use our discretion in determining when and how to follow up on reported
incidents, which may range from not taking action to permanent expulsion from
the project and project-sponsored spaces. We will notify the accused of the
report and provide them an opportunity to discuss it before any action is taken.
The identity of the reporter will be omitted from the details of the report
supplied to the accused. In potentially harmful situations, such as ongoing
harassment or threats to anyone's safety, we may take action without notice.

Attribution Copy Chapter

This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct/

Contributing (`docs/contributing.md`) Copy Section

How to Contribute

We would love to accept your patches and contributions to this project.

Before you begin Copy Chapter

Sign our Contributor License Agreement Copy Section

Contributions to this project must be accompanied by a
Contributor License Agreement (CLA).
You (or your employer) retain the copyright to your contribution; this simply
gives us permission to use and redistribute your contributions as part of the
project.

If you or your current employer have already signed the Google CLA (even if it
was for a different project), you probably don't need to do it again.

Visit https://cla.developers.google.com/ to see your current agreements or to
sign a new one.

Review our Community Guidelines Copy Section

This project follows Google's Open Source Community
Guidelines.

Contribution process Copy Chapter

Building and testing locally Copy Section

Steps to build locally:

1. clone this repo
2. cd generative-ai-js
3. Run npm install to install dependencies.
4. Make changes as needed to source code.
5. Run npm run build to build.
6. Run npm run test to run unit tests.
7. Run npm run docs to generate any changes to reference docs (destination dir is docs/reference).
8. Run npm run format to fix formatting and add license headers as needed.
9. Run npx @changesets/cli to generate the changeset summary.

Code Reviews Copy Section

All submissions, including submissions by project members, require review. We
use GitHub pull requests
for this purpose.

Reference Files Generative Ai.Errordetails. Type (`docs/reference/files/generative-ai.errordetails.__type_.md`) Copy Section

Home > @google/generative-ai > ErrorDetails > "@type"

ErrorDetails."@type" property Copy Chapter

Signature:

"@type"?: string;

Reference Files Generative Ai.Errordetails.Domain (`docs/reference/files/generative-ai.errordetails.domain.md`) Copy Section

Home > @google/generative-ai > ErrorDetails > domain

ErrorDetails.domain property Copy Chapter

Signature:

domain?: string;

Reference Files Generative Ai.Errordetails (`docs/reference/files/generative-ai.errordetails.md`) Copy Section

Home > @google/generative-ai > ErrorDetails

ErrorDetails interface Copy Chapter

Details object that may be included in an error response.

Signature:

export interface ErrorDetails

Properties Copy Chapter

Reference Files Generative Ai.Errordetails.Metadata (`docs/reference/files/generative-ai.errordetails.metadata.md`) Copy Section

Home > @google/generative-ai > ErrorDetails > metadata

ErrorDetails.metadata property Copy Chapter

Signature:

metadata?: Record<string, unknown>;

Reference Files Generative Ai.Errordetails.Reason (`docs/reference/files/generative-ai.errordetails.reason.md`) Copy Section

Home > @google/generative-ai > ErrorDetails > reason

ErrorDetails.reason property Copy Chapter

Signature:

reason?: string;

Reference Files Generative Ai.Filemetadata.Displayname (`docs/reference/files/generative-ai.filemetadata.displayname.md`) Copy Section

Home > @google/generative-ai > FileMetadata > displayName

FileMetadata.displayName property Copy Chapter

Signature:

displayName?: string;

Reference Files Generative Ai.Filemetadata (`docs/reference/files/generative-ai.filemetadata.md`) Copy Section

Home > @google/generative-ai > FileMetadata

FileMetadata interface Copy Chapter

Metadata to provide alongside a file upload

Signature:

export interface FileMetadata

Properties Copy Chapter

Reference Files Generative Ai.Filemetadata.Mimetype (`docs/reference/files/generative-ai.filemetadata.mimetype.md`) Copy Section

Home > @google/generative-ai > FileMetadata > mimeType

FileMetadata.mimeType property Copy Chapter

Signature:

mimeType: string;

Reference Files Generative Ai.Filemetadata.Name (`docs/reference/files/generative-ai.filemetadata.name.md`) Copy Section

Home > @google/generative-ai > FileMetadata > name

FileMetadata.name property Copy Chapter

Signature:

name?: string;

Reference Files Generative Ai.Filemetadataresponse.Createtime (`docs/reference/files/generative-ai.filemetadataresponse.createtime.md`) Copy Section

Home > @google/generative-ai > FileMetadataResponse > createTime

FileMetadataResponse.createTime property Copy Chapter

Signature:

createTime: string;

Reference Files Generative Ai.Filemetadataresponse.Displayname (`docs/reference/files/generative-ai.filemetadataresponse.displayname.md`) Copy Section

Home > @google/generative-ai > FileMetadataResponse > displayName

FileMetadataResponse.displayName property Copy Chapter

Signature:

displayName?: string;

Reference Files Generative Ai.Filemetadataresponse.Error (`docs/reference/files/generative-ai.filemetadataresponse.error.md`) Copy Section

Home > @google/generative-ai > FileMetadataResponse > error

FileMetadataResponse.error property Copy Chapter

Error populated if file processing has failed.

Signature:

error?: RpcStatus;

Reference Files Generative Ai.Filemetadataresponse.Expirationtime (`docs/reference/files/generative-ai.filemetadataresponse.expirationtime.md`) Copy Section

Home > @google/generative-ai > FileMetadataResponse > expirationTime

FileMetadataResponse.expirationTime property Copy Chapter

Signature:

expirationTime: string;

Reference Files Generative Ai.Filemetadataresponse (`docs/reference/files/generative-ai.filemetadataresponse.md`) Copy Section

Home > @google/generative-ai > FileMetadataResponse

FileMetadataResponse interface Copy Chapter

File metadata response from server.

Signature:

export interface FileMetadataResponse

Properties Copy Chapter

Reference Files Generative Ai.Filemetadataresponse.Mimetype (`docs/reference/files/generative-ai.filemetadataresponse.mimetype.md`) Copy Section

Home > @google/generative-ai > FileMetadataResponse > mimeType

FileMetadataResponse.mimeType property Copy Chapter

Signature:

mimeType: string;

Reference Files Generative Ai.Filemetadataresponse.Name (`docs/reference/files/generative-ai.filemetadataresponse.name.md`) Copy Section

Home > @google/generative-ai > FileMetadataResponse > name

FileMetadataResponse.name property Copy Chapter

Signature:

name: string;

Reference Files Generative Ai.Filemetadataresponse.Sha256hash (`docs/reference/files/generative-ai.filemetadataresponse.sha256hash.md`) Copy Section

Home > @google/generative-ai > FileMetadataResponse > sha256Hash

FileMetadataResponse.sha256Hash property Copy Chapter

Signature:

sha256Hash: string;

Reference Files Generative Ai.Filemetadataresponse.Sizebytes (`docs/reference/files/generative-ai.filemetadataresponse.sizebytes.md`) Copy Section

Home > @google/generative-ai > FileMetadataResponse > sizeBytes

FileMetadataResponse.sizeBytes property Copy Chapter

Signature:

sizeBytes: string;

Reference Files Generative Ai.Filemetadataresponse.State (`docs/reference/files/generative-ai.filemetadataresponse.state.md`) Copy Section

Home > @google/generative-ai > FileMetadataResponse > state

FileMetadataResponse.state property Copy Chapter

Signature:

state: FileState;

Reference Files Generative Ai.Filemetadataresponse.Updatetime (`docs/reference/files/generative-ai.filemetadataresponse.updatetime.md`) Copy Section

Home > @google/generative-ai > FileMetadataResponse > updateTime

FileMetadataResponse.updateTime property Copy Chapter

Signature:

updateTime: string;

Reference Files Generative Ai.Filemetadataresponse.Uri (`docs/reference/files/generative-ai.filemetadataresponse.uri.md`) Copy Section

Home > @google/generative-ai > FileMetadataResponse > uri

FileMetadataResponse.uri property Copy Chapter

Signature:

uri: string;

Reference Files Generative Ai.Filemetadataresponse.Videometadata (`docs/reference/files/generative-ai.filemetadataresponse.videometadata.md`) Copy Section

Home > @google/generative-ai > FileMetadataResponse > videoMetadata

FileMetadataResponse.videoMetadata property Copy Chapter

Video metadata populated after processing is complete.

Signature:

videoMetadata?: VideoMetadata;

Reference Files Generative Ai.Filestate (`docs/reference/files/generative-ai.filestate.md`) Copy Section

Home > @google/generative-ai > FileState

FileState enum Copy Chapter

Processing state of the File.

Signature:

export declare enum FileState

Enumeration Members Copy Chapter

Reference Files Generative Ai.Googleaifilemanager. Constructor (`docs/reference/files/generative-ai.googleaifilemanager._constructor_.md`) Copy Section

Home > @google/generative-ai > GoogleAIFileManager > (constructor)

GoogleAIFileManager.(constructor) Copy Chapter

Constructs a new instance of the GoogleAIFileManager class

Signature:

constructor(apiKey: string, _requestOptions?: RequestOptions);

Parameters Copy Chapter

Reference Files Generative Ai.Googleaifilemanager.Apikey (`docs/reference/files/generative-ai.googleaifilemanager.apikey.md`) Copy Section

Home > @google/generative-ai > GoogleAIFileManager > apiKey

GoogleAIFileManager.apiKey property Copy Chapter

Signature:

apiKey: string;

Reference Files Generative Ai.Googleaifilemanager.Deletefile (`docs/reference/files/generative-ai.googleaifilemanager.deletefile.md`) Copy Section

Home > @google/generative-ai > GoogleAIFileManager > deleteFile

GoogleAIFileManager.deleteFile() method Copy Chapter

Delete file with given ID.

Any fields set in the optional SingleRequestOptions parameter will take precedence over the RequestOptions values provided at the time of the GoogleAIFileManager initialization.

Signature:

deleteFile(fileId: string, requestOptions?: SingleRequestOptions): Promise<void>;

Parameters Copy Chapter

Returns:

Promise<void>

Reference Files Generative Ai.Googleaifilemanager.Getfile (`docs/reference/files/generative-ai.googleaifilemanager.getfile.md`) Copy Section

Home > @google/generative-ai > GoogleAIFileManager > getFile

GoogleAIFileManager.getFile() method Copy Chapter

Get metadata for file with given ID.

Any fields set in the optional SingleRequestOptions parameter will take precedence over the RequestOptions values provided at the time of the GoogleAIFileManager initialization.

Signature:

getFile(fileId: string, requestOptions?: SingleRequestOptions): Promise<FileMetadataResponse>;

Parameters Copy Chapter

Returns:

Promise<FileMetadataResponse>

Reference Files Generative Ai.Googleaifilemanager.Listfiles (`docs/reference/files/generative-ai.googleaifilemanager.listfiles.md`) Copy Section

Home > @google/generative-ai > GoogleAIFileManager > listFiles

GoogleAIFileManager.listFiles() method Copy Chapter

List all uploaded files.

Any fields set in the optional SingleRequestOptions parameter will take precedence over the RequestOptions values provided at the time of the GoogleAIFileManager initialization.

Signature:

listFiles(listParams?: ListParams, requestOptions?: SingleRequestOptions): Promise<ListFilesResponse>;

Parameters Copy Chapter

Returns:

Promise<ListFilesResponse>

Reference Files Generative Ai.Googleaifilemanager (`docs/reference/files/generative-ai.googleaifilemanager.md`) Copy Section

Home > @google/generative-ai > GoogleAIFileManager

GoogleAIFileManager class Copy Chapter

Class for managing GoogleAI file uploads.

Signature:

export declare class GoogleAIFileManager

Constructors Copy Chapter

Properties Copy Chapter

Methods Copy Chapter

Reference Files Generative Ai.Googleaifilemanager.Uploadfile (`docs/reference/files/generative-ai.googleaifilemanager.uploadfile.md`) Copy Section

Home > @google/generative-ai > GoogleAIFileManager > uploadFile

GoogleAIFileManager.uploadFile() method Copy Chapter

Upload a file.

Any fields set in the optional SingleRequestOptions parameter will take precedence over the RequestOptions values provided at the time of the GoogleAIFileManager initialization.

Signature:

uploadFile(filePath: string, fileMetadata: FileMetadata, requestOptions?: SingleRequestOptions): Promise<UploadFileResponse>;

Parameters Copy Chapter

Returns:

Promise<UploadFileResponse>

Reference Files Generative Ai.Listfilesresponse.Files (`docs/reference/files/generative-ai.listfilesresponse.files.md`) Copy Section

Home > @google/generative-ai > ListFilesResponse > files

ListFilesResponse.files property Copy Chapter

Signature:

files: FileMetadataResponse[];

Reference Files Generative Ai.Listfilesresponse (`docs/reference/files/generative-ai.listfilesresponse.md`) Copy Section

Home > @google/generative-ai > ListFilesResponse

ListFilesResponse interface Copy Chapter

Response from calling GoogleAIFileManager.listFiles()

Signature:

export interface ListFilesResponse

Properties Copy Chapter

Reference Files Generative Ai.Listfilesresponse.Nextpagetoken (`docs/reference/files/generative-ai.listfilesresponse.nextpagetoken.md`) Copy Section

Home > @google/generative-ai > ListFilesResponse > nextPageToken

ListFilesResponse.nextPageToken property Copy Chapter

Signature:

nextPageToken?: string;

Reference Files Generative Ai.Listparams (`docs/reference/files/generative-ai.listparams.md`) Copy Section

Home > @google/generative-ai > ListParams

ListParams interface Copy Chapter

Params to pass to GoogleAIFileManager.listFiles()

Signature:

export interface ListParams

Properties Copy Chapter

Reference Files Generative Ai.Listparams.Pagesize (`docs/reference/files/generative-ai.listparams.pagesize.md`) Copy Section

Home > @google/generative-ai > ListParams > pageSize

ListParams.pageSize property Copy Chapter

Signature:

pageSize?: number;

Reference Files Generative Ai.Listparams.Pagetoken (`docs/reference/files/generative-ai.listparams.pagetoken.md`) Copy Section

Home > @google/generative-ai > ListParams > pageToken

ListParams.pageToken property Copy Chapter

Signature:

pageToken?: string;

Reference Files Generative Ai (`docs/reference/files/generative-ai.md`) Copy Section

Home > @google/generative-ai

generative-ai package Copy Chapter

Classes Copy Chapter

Enumerations Copy Chapter

Interfaces Copy Chapter

Reference Files Generative Ai.Requestoptions.Apiclient (`docs/reference/files/generative-ai.requestoptions.apiclient.md`) Copy Section

Home > @google/generative-ai > RequestOptions > apiClient

RequestOptions.apiClient property Copy Chapter

Additional attribution information to include in the x-goog-api-client header. Used by wrapper SDKs.

Signature:

apiClient?: string;

Reference Files Generative Ai.Requestoptions.Apiversion (`docs/reference/files/generative-ai.requestoptions.apiversion.md`) Copy Section

Home > @google/generative-ai > RequestOptions > apiVersion

RequestOptions.apiVersion property Copy Chapter

Version of API endpoint to call (e.g. "v1" or "v1beta"). If not specified, defaults to latest stable version.

Signature:

apiVersion?: string;

Reference Files Generative Ai.Requestoptions.Baseurl (`docs/reference/files/generative-ai.requestoptions.baseurl.md`) Copy Section

Home > @google/generative-ai > RequestOptions > baseUrl

RequestOptions.baseUrl property Copy Chapter

Base endpoint url. Defaults to "https://generativelanguage.googleapis.com"

Signature:

baseUrl?: string;

Reference Files Generative Ai.Requestoptions.Customheaders (`docs/reference/files/generative-ai.requestoptions.customheaders.md`) Copy Section

Home > @google/generative-ai > RequestOptions > customHeaders

RequestOptions.customHeaders property Copy Chapter

Custom HTTP request headers.

Signature:

customHeaders?: Headers | Record<string, string>;

Reference Files Generative Ai.Requestoptions (`docs/reference/files/generative-ai.requestoptions.md`) Copy Section

Home > @google/generative-ai > RequestOptions

RequestOptions interface Copy Chapter

Params passed to getGenerativeModel() or GoogleAIFileManager().

Signature:

export interface RequestOptions

Properties Copy Chapter

Reference Files Generative Ai.Requestoptions.Timeout (`docs/reference/files/generative-ai.requestoptions.timeout.md`) Copy Section

Home > @google/generative-ai > RequestOptions > timeout

RequestOptions.timeout property Copy Chapter

Request timeout in milliseconds.

Signature:

timeout?: number;

Reference Files Generative Ai.Rpcstatus.Code (`docs/reference/files/generative-ai.rpcstatus.code.md`) Copy Section

Home > @google/generative-ai > RpcStatus > code

RpcStatus.code property Copy Chapter

Error status code

Signature:

code: number;

Reference Files Generative Ai.Rpcstatus.Details (`docs/reference/files/generative-ai.rpcstatus.details.md`) Copy Section

Home > @google/generative-ai > RpcStatus > details

RpcStatus.details property Copy Chapter

A list of messages that carry the error details.

Signature:

details?: ErrorDetails[];

Reference Files Generative Ai.Rpcstatus (`docs/reference/files/generative-ai.rpcstatus.md`) Copy Section

Home > @google/generative-ai > RpcStatus

RpcStatus interface Copy Chapter

Standard RPC error status object.

Signature:

export interface RpcStatus

Properties Copy Chapter

Reference Files Generative Ai.Rpcstatus.Message (`docs/reference/files/generative-ai.rpcstatus.message.md`) Copy Section

Home > @google/generative-ai > RpcStatus > message

RpcStatus.message property Copy Chapter

A developer-facing error message.

Signature:

message: string;

Reference Files Generative Ai.Singlerequestoptions (`docs/reference/files/generative-ai.singlerequestoptions.md`) Copy Section

Home > @google/generative-ai > SingleRequestOptions

SingleRequestOptions interface Copy Chapter

Params passed to atomic asynchronous operations.

Signature:

export interface SingleRequestOptions extends RequestOptions

Extends: RequestOptions

Properties Copy Chapter

Reference Files Generative Ai.Singlerequestoptions.Signal (`docs/reference/files/generative-ai.singlerequestoptions.signal.md`) Copy Section

Home > @google/generative-ai > SingleRequestOptions > signal

SingleRequestOptions.signal property Copy Chapter

An object that may be used to abort asynchronous requests. The request may also be aborted due to the expiration of the timeout value, if provided, and if the timeout occurs first.

Signature:

signal?: AbortSignal;

Reference Files Generative Ai.Uploadfileresponse.File (`docs/reference/files/generative-ai.uploadfileresponse.file.md`) Copy Section

Home > @google/generative-ai > UploadFileResponse > file

UploadFileResponse.file property Copy Chapter

Signature:

file: FileMetadataResponse;

Reference Files Generative Ai.Uploadfileresponse (`docs/reference/files/generative-ai.uploadfileresponse.md`) Copy Section

Home > @google/generative-ai > UploadFileResponse

UploadFileResponse interface Copy Chapter

Response from calling GoogleAIFileManager.uploadFile()

Signature:

export interface UploadFileResponse

Properties Copy Chapter

Reference Files Generative Ai.Videometadata (`docs/reference/files/generative-ai.videometadata.md`) Copy Section

Home > @google/generative-ai > VideoMetadata

VideoMetadata interface Copy Chapter

Metadata populated when video has been processed.

Signature:

export interface VideoMetadata

Properties Copy Chapter

Reference Files Generative Ai.Videometadata.Videoduration (`docs/reference/files/generative-ai.videometadata.videoduration.md`) Copy Section

Home > @google/generative-ai > VideoMetadata > videoDuration

VideoMetadata.videoDuration property Copy Chapter

The video duration in protobuf Duration format.

Signature:

videoDuration: string;

Reference Main Generative Ai.Arrayschema.Items (`docs/reference/main/generative-ai.arrayschema.items.md`) Copy Section

Home > @google/generative-ai > ArraySchema > items

ArraySchema.items property Copy Chapter

A schema describing the entries in the array.

Signature:

items: Schema;

Reference Main Generative Ai.Arrayschema.Maxitems (`docs/reference/main/generative-ai.arrayschema.maxitems.md`) Copy Section

Home > @google/generative-ai > ArraySchema > maxItems

ArraySchema.maxItems property Copy Chapter

The maximum number of items in the array.

Signature:

maxItems?: number;

Reference Main Generative Ai.Arrayschema (`docs/reference/main/generative-ai.arrayschema.md`) Copy Section

Home > @google/generative-ai > ArraySchema

ArraySchema interface Copy Chapter

Describes an array, an ordered list of values.

Signature:

export interface ArraySchema extends BaseSchema

Extends: BaseSchema

Properties Copy Chapter

Reference Main Generative Ai.Arrayschema.Minitems (`docs/reference/main/generative-ai.arrayschema.minitems.md`) Copy Section

Home > @google/generative-ai > ArraySchema > minItems

ArraySchema.minItems property Copy Chapter

The minimum number of items in the array.

Signature:

minItems?: number;

Reference Main Generative Ai.Arrayschema.Type (`docs/reference/main/generative-ai.arrayschema.type.md`) Copy Section

Home > @google/generative-ai > ArraySchema > type

ArraySchema.type property Copy Chapter

Signature:

type: typeof SchemaType.ARRAY;

Reference Main Generative Ai.Baseparams.Generationconfig (`docs/reference/main/generative-ai.baseparams.generationconfig.md`) Copy Section

Home > @google/generative-ai > BaseParams > generationConfig

BaseParams.generationConfig property Copy Chapter

Signature:

generationConfig?: GenerationConfig;

Reference Main Generative Ai.Baseparams (`docs/reference/main/generative-ai.baseparams.md`) Copy Section

Home > @google/generative-ai > BaseParams

BaseParams interface Copy Chapter

Base parameters for a number of methods.

Signature:

export interface BaseParams

Properties Copy Chapter

Reference Main Generative Ai.Baseparams.Safetysettings (`docs/reference/main/generative-ai.baseparams.safetysettings.md`) Copy Section

Home > @google/generative-ai > BaseParams > safetySettings

BaseParams.safetySettings property Copy Chapter

Signature:

safetySettings?: SafetySetting[];

Reference Main Generative Ai.Batchembedcontentsrequest (`docs/reference/main/generative-ai.batchembedcontentsrequest.md`) Copy Section

Home > @google/generative-ai > BatchEmbedContentsRequest

BatchEmbedContentsRequest interface Copy Chapter

Params for calling GenerativeModel.batchEmbedContents()

Signature:

export interface BatchEmbedContentsRequest

Properties Copy Chapter

Reference Main Generative Ai.Batchembedcontentsrequest.Requests (`docs/reference/main/generative-ai.batchembedcontentsrequest.requests.md`) Copy Section

Home > @google/generative-ai > BatchEmbedContentsRequest > requests

BatchEmbedContentsRequest.requests property Copy Chapter

Signature:

requests: EmbedContentRequest[];

Reference Main Generative Ai.Batchembedcontentsresponse.Embeddings (`docs/reference/main/generative-ai.batchembedcontentsresponse.embeddings.md`) Copy Section

Home > @google/generative-ai > BatchEmbedContentsResponse > embeddings

BatchEmbedContentsResponse.embeddings property Copy Chapter

Signature:

embeddings: ContentEmbedding[];

Reference Main Generative Ai.Batchembedcontentsresponse (`docs/reference/main/generative-ai.batchembedcontentsresponse.md`) Copy Section

Home > @google/generative-ai > BatchEmbedContentsResponse

BatchEmbedContentsResponse interface Copy Chapter

Response from calling GenerativeModel.batchEmbedContents().

Signature:

export interface BatchEmbedContentsResponse

Properties Copy Chapter

Reference Main Generative Ai.Blockreason (`docs/reference/main/generative-ai.blockreason.md`) Copy Section

Home > @google/generative-ai > BlockReason

BlockReason enum Copy Chapter

Reason that a prompt was blocked.

Signature:

export declare enum BlockReason

Enumeration Members Copy Chapter

Reference Main Generative Ai.Booleanschema (`docs/reference/main/generative-ai.booleanschema.md`) Copy Section

Home > @google/generative-ai > BooleanSchema

BooleanSchema interface Copy Chapter

Describes a boolean, either 'true' or 'false'.

Signature:

export interface BooleanSchema extends BaseSchema

Extends: BaseSchema

Properties Copy Chapter

Reference Main Generative Ai.Booleanschema.Type (`docs/reference/main/generative-ai.booleanschema.type.md`) Copy Section

Home > @google/generative-ai > BooleanSchema > type

BooleanSchema.type property Copy Chapter

Signature:

type: typeof SchemaType.BOOLEAN;

Reference Main Generative Ai.Cachedcontent.Createtime (`docs/reference/main/generative-ai.cachedcontent.createtime.md`) Copy Section

Home > @google/generative-ai > CachedContent > createTime

CachedContent.createTime property Copy Chapter

CachedContent creation time in ISO string format.

Signature:

createTime?: string;

Reference Main Generative Ai.Cachedcontent (`docs/reference/main/generative-ai.cachedcontent.md`) Copy Section

Home > @google/generative-ai > CachedContent

CachedContent interface Copy Chapter

Describes CachedContent interface for sending to the server (if creating) or received from the server (using getters or list methods).

Signature:

export interface CachedContent extends CachedContentBase

Extends: CachedContentBase

Properties Copy Chapter

Reference Main Generative Ai.Cachedcontent.Name (`docs/reference/main/generative-ai.cachedcontent.name.md`) Copy Section

Home > @google/generative-ai > CachedContent > name

CachedContent.name property Copy Chapter

Signature:

name?: string;

Reference Main Generative Ai.Cachedcontent.Ttl (`docs/reference/main/generative-ai.cachedcontent.ttl.md`) Copy Section

Home > @google/generative-ai > CachedContent > ttl

CachedContent.ttl property Copy Chapter

protobuf.Duration format (ex. "3.0001s").

Signature:

ttl?: string;

Reference Main Generative Ai.Cachedcontent.Updatetime (`docs/reference/main/generative-ai.cachedcontent.updatetime.md`) Copy Section

Home > @google/generative-ai > CachedContent > updateTime

CachedContent.updateTime property Copy Chapter

CachedContent update time in ISO string format.

Signature:

updateTime?: string;

Reference Main Generative Ai.Cachedcontentbase.Contents (`docs/reference/main/generative-ai.cachedcontentbase.contents.md`) Copy Section

Home > @google/generative-ai > CachedContentBase > contents

CachedContentBase.contents property Copy Chapter

Signature:

contents: Content[];

Reference Main Generative Ai.Cachedcontentbase.Displayname (`docs/reference/main/generative-ai.cachedcontentbase.displayname.md`) Copy Section

Home > @google/generative-ai > CachedContentBase > displayName

CachedContentBase.displayName property Copy Chapter

Signature:

displayName?: string;

Reference Main Generative Ai.Cachedcontentbase.Expiretime (`docs/reference/main/generative-ai.cachedcontentbase.expiretime.md`) Copy Section

Home > @google/generative-ai > CachedContentBase > expireTime

CachedContentBase.expireTime property Copy Chapter

Expiration time in ISO string format. Specify either this or ttlSeconds when creating a CachedContent.

Signature:

expireTime?: string;

Reference Main Generative Ai.Cachedcontentbase (`docs/reference/main/generative-ai.cachedcontentbase.md`) Copy Section

Home > @google/generative-ai > CachedContentBase

CachedContentBase interface Copy Chapter

Signature:

export interface CachedContentBase

Properties Copy Chapter

Reference Main Generative Ai.Cachedcontentbase.Model (`docs/reference/main/generative-ai.cachedcontentbase.model.md`) Copy Section

Home > @google/generative-ai > CachedContentBase > model

CachedContentBase.model property Copy Chapter

Signature:

model?: string;

Reference Main Generative Ai.Cachedcontentbase.Systeminstruction (`docs/reference/main/generative-ai.cachedcontentbase.systeminstruction.md`) Copy Section

Home > @google/generative-ai > CachedContentBase > systemInstruction

CachedContentBase.systemInstruction property Copy Chapter

Signature:

systemInstruction?: string | Part | Content;

Reference Main Generative Ai.Cachedcontentbase.Toolconfig (`docs/reference/main/generative-ai.cachedcontentbase.toolconfig.md`) Copy Section

Home > @google/generative-ai > CachedContentBase > toolConfig

CachedContentBase.toolConfig property Copy Chapter

Signature:

toolConfig?: ToolConfig;

Reference Main Generative Ai.Cachedcontentbase.Tools (`docs/reference/main/generative-ai.cachedcontentbase.tools.md`) Copy Section

Home > @google/generative-ai > CachedContentBase > tools

CachedContentBase.tools property Copy Chapter

Signature:

tools?: Tool[];

Reference Main Generative Ai.Chatsession. Constructor (`docs/reference/main/generative-ai.chatsession._constructor_.md`) Copy Section

Home > @google/generative-ai > ChatSession > (constructor)

ChatSession.(constructor) Copy Chapter

Constructs a new instance of the ChatSession class

Signature:

constructor(apiKey: string, model: string, params?: StartChatParams, _requestOptions?: RequestOptions);

Parameters Copy Chapter

Reference Main Generative Ai.Chatsession.Gethistory (`docs/reference/main/generative-ai.chatsession.gethistory.md`) Copy Section

Home > @google/generative-ai > ChatSession > getHistory

ChatSession.getHistory() method Copy Chapter

Gets the chat history so far. Blocked prompts are not added to history. Blocked candidates are not added to history, nor are the prompts that generated them.

Signature:

getHistory(): Promise<Content[]>;

Returns:

Promise<Content[]>

Reference Main Generative Ai.Chatsession (`docs/reference/main/generative-ai.chatsession.md`) Copy Section

Home > @google/generative-ai > ChatSession

ChatSession class Copy Chapter

ChatSession class that enables sending chat messages and stores history of sent and received messages so far.

Signature:

export declare class ChatSession

Constructors Copy Chapter

Properties Copy Chapter

Methods Copy Chapter

Reference Main Generative Ai.Chatsession.Model (`docs/reference/main/generative-ai.chatsession.model.md`) Copy Section

Home > @google/generative-ai > ChatSession > model

ChatSession.model property Copy Chapter

Signature:

model: string;

Reference Main Generative Ai.Chatsession.Params (`docs/reference/main/generative-ai.chatsession.params.md`) Copy Section

Home > @google/generative-ai > ChatSession > params

ChatSession.params property Copy Chapter

Signature:

params?: StartChatParams;

Reference Main Generative Ai.Chatsession.Sendmessage (`docs/reference/main/generative-ai.chatsession.sendmessage.md`) Copy Section

Home > @google/generative-ai > ChatSession > sendMessage

ChatSession.sendMessage() method Copy Chapter

Sends a chat message and receives a non-streaming GenerateContentResult.

Fields set in the optional SingleRequestOptions parameter will take precedence over the RequestOptions values provided to GoogleGenerativeAI.getGenerativeModel().

Signature:

sendMessage(request: string | Array<string | Part>, requestOptions?: SingleRequestOptions): Promise<GenerateContentResult>;

Parameters Copy Chapter

Returns:

Promise<GenerateContentResult>

Reference Main Generative Ai.Chatsession.Sendmessagestream (`docs/reference/main/generative-ai.chatsession.sendmessagestream.md`) Copy Section

Home > @google/generative-ai > ChatSession > sendMessageStream

ChatSession.sendMessageStream() method Copy Chapter

Sends a chat message and receives the response as a GenerateContentStreamResult containing an iterable stream and a response promise.

Fields set in the optional SingleRequestOptions parameter will take precedence over the RequestOptions values provided to GoogleGenerativeAI.getGenerativeModel().

Signature:

sendMessageStream(request: string | Array<string | Part>, requestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;

Parameters Copy Chapter

Returns:

Promise<GenerateContentStreamResult>

Reference Main Generative Ai.Citationmetadata.Citationsources (`docs/reference/main/generative-ai.citationmetadata.citationsources.md`) Copy Section

Home > @google/generative-ai > CitationMetadata > citationSources

CitationMetadata.citationSources property Copy Chapter

Signature:

citationSources: CitationSource[];

Reference Main Generative Ai.Citationmetadata (`docs/reference/main/generative-ai.citationmetadata.md`) Copy Section

Home > @google/generative-ai > CitationMetadata

CitationMetadata interface Copy Chapter

Citation metadata that may be found on a GenerateContentCandidate.

Signature:

export interface CitationMetadata

Properties Copy Chapter

Reference Main Generative Ai.Citationsource.License (`docs/reference/main/generative-ai.citationsource.license.md`) Copy Section

Home > @google/generative-ai > CitationSource > license

CitationSource.license property Copy Chapter

Signature:

license?: string;

Reference Main Generative Ai.Citationsource (`docs/reference/main/generative-ai.citationsource.md`) Copy Section

Home > @google/generative-ai > CitationSource

CitationSource interface Copy Chapter

A single citation source.

Signature:

export interface CitationSource

Properties Copy Chapter

Reference Main Generative Ai.Citationsource.Uri (`docs/reference/main/generative-ai.citationsource.uri.md`) Copy Section

Home > @google/generative-ai > CitationSource > uri

CitationSource.uri property Copy Chapter

Signature:

uri?: string;

Reference Main Generative Ai.Codeexecutionresult (`docs/reference/main/generative-ai.codeexecutionresult.md`) Copy Section

Home > @google/generative-ai > CodeExecutionResult

CodeExecutionResult interface Copy Chapter

Result of executing the ExecutableCode. Only generated when using code execution, and always follows a Part containing the ExecutableCode.

Signature:

export interface CodeExecutionResult

Properties Copy Chapter

Reference Main Generative Ai.Codeexecutionresult.Outcome (`docs/reference/main/generative-ai.codeexecutionresult.outcome.md`) Copy Section

Home > @google/generative-ai > CodeExecutionResult > outcome

CodeExecutionResult.outcome property Copy Chapter

Outcome of the code execution.

Signature:

outcome: Outcome;

Reference Main Generative Ai.Codeexecutionresult.Output (`docs/reference/main/generative-ai.codeexecutionresult.output.md`) Copy Section

Home > @google/generative-ai > CodeExecutionResult > output

CodeExecutionResult.output property Copy Chapter

Contains stdout when code execution is successful, stderr or other description otherwise.

Signature:

output: string;

Reference Main Generative Ai.Codeexecutionresultpart.Codeexecutionresult (`docs/reference/main/generative-ai.codeexecutionresultpart.codeexecutionresult.md`) Copy Section

Home > @google/generative-ai > CodeExecutionResultPart > codeExecutionResult

CodeExecutionResultPart.codeExecutionResult property Copy Chapter

Signature:

codeExecutionResult: CodeExecutionResult;

Reference Main Generative Ai.Codeexecutionresultpart.Executablecode (`docs/reference/main/generative-ai.codeexecutionresultpart.executablecode.md`) Copy Section

Home > @google/generative-ai > CodeExecutionResultPart > executableCode

CodeExecutionResultPart.executableCode property Copy Chapter

Signature:

executableCode?: never;

Reference Main Generative Ai.Codeexecutionresultpart.Filedata (`docs/reference/main/generative-ai.codeexecutionresultpart.filedata.md`) Copy Section

Home > @google/generative-ai > CodeExecutionResultPart > fileData

CodeExecutionResultPart.fileData property Copy Chapter

Signature:

fileData?: never;

Reference Main Generative Ai.Codeexecutionresultpart.Functioncall (`docs/reference/main/generative-ai.codeexecutionresultpart.functioncall.md`) Copy Section

Home > @google/generative-ai > CodeExecutionResultPart > functionCall

CodeExecutionResultPart.functionCall property Copy Chapter

Signature:

functionCall?: never;

Reference Main Generative Ai.Codeexecutionresultpart.Functionresponse (`docs/reference/main/generative-ai.codeexecutionresultpart.functionresponse.md`) Copy Section

Home > @google/generative-ai > CodeExecutionResultPart > functionResponse

CodeExecutionResultPart.functionResponse property Copy Chapter

Signature:

functionResponse?: never;

Reference Main Generative Ai.Codeexecutionresultpart.Inlinedata (`docs/reference/main/generative-ai.codeexecutionresultpart.inlinedata.md`) Copy Section

Home > @google/generative-ai > CodeExecutionResultPart > inlineData

CodeExecutionResultPart.inlineData property Copy Chapter

Signature:

inlineData?: never;

Reference Main Generative Ai.Codeexecutionresultpart (`docs/reference/main/generative-ai.codeexecutionresultpart.md`) Copy Section

Home > @google/generative-ai > CodeExecutionResultPart

CodeExecutionResultPart interface Copy Chapter

Content part containing the result of executed code.

Signature:

export interface CodeExecutionResultPart

Properties Copy Chapter

Reference Main Generative Ai.Codeexecutionresultpart.Text (`docs/reference/main/generative-ai.codeexecutionresultpart.text.md`) Copy Section

Home > @google/generative-ai > CodeExecutionResultPart > text

CodeExecutionResultPart.text property Copy Chapter

Signature:

text?: never;

Reference Main Generative Ai.Codeexecutiontool.Codeexecution (`docs/reference/main/generative-ai.codeexecutiontool.codeexecution.md`) Copy Section

Home > @google/generative-ai > CodeExecutionTool > codeExecution

CodeExecutionTool.codeExecution property Copy Chapter

Provide an empty object to enable code execution. This field may have subfields added in the future.

Signature:

codeExecution: {};

Reference Main Generative Ai.Codeexecutiontool (`docs/reference/main/generative-ai.codeexecutiontool.md`) Copy Section

Home > @google/generative-ai > CodeExecutionTool

CodeExecutionTool interface Copy Chapter

Enables the model to execute code as part of generation.

Signature:

export interface CodeExecutionTool

Properties Copy Chapter

Reference Main Generative Ai.Content (`docs/reference/main/generative-ai.content.md`) Copy Section

Home > @google/generative-ai > Content

Content interface Copy Chapter

Content type for both prompts and response candidates.

Signature:

export interface Content

Properties Copy Chapter

Reference Main Generative Ai.Content.Parts (`docs/reference/main/generative-ai.content.parts.md`) Copy Section

Home > @google/generative-ai > Content > parts

Content.parts property Copy Chapter

Signature:

parts: Part[];

Reference Main Generative Ai.Content.Role (`docs/reference/main/generative-ai.content.role.md`) Copy Section

Home > @google/generative-ai > Content > role

Content.role property Copy Chapter

Signature:

role: string;

Reference Main Generative Ai.Contentembedding (`docs/reference/main/generative-ai.contentembedding.md`) Copy Section

Home > @google/generative-ai > ContentEmbedding

ContentEmbedding interface Copy Chapter

A single content embedding.

Signature:

export interface ContentEmbedding

Properties Copy Chapter

Reference Main Generative Ai.Contentembedding.Values (`docs/reference/main/generative-ai.contentembedding.values.md`) Copy Section

Home > @google/generative-ai > ContentEmbedding > values

ContentEmbedding.values property Copy Chapter

Signature:

values: number[];

Reference Main Generative Ai.Counttokensrequest.Contents (`docs/reference/main/generative-ai.counttokensrequest.contents.md`) Copy Section

Home > @google/generative-ai > CountTokensRequest > contents

CountTokensRequest.contents property Copy Chapter

Signature:

contents?: Content[];

Reference Main Generative Ai.Counttokensrequest.Generatecontentrequest (`docs/reference/main/generative-ai.counttokensrequest.generatecontentrequest.md`) Copy Section

Home > @google/generative-ai > CountTokensRequest > generateContentRequest

CountTokensRequest.generateContentRequest property Copy Chapter

Signature:

generateContentRequest?: GenerateContentRequest;

Reference Main Generative Ai.Counttokensrequest (`docs/reference/main/generative-ai.counttokensrequest.md`) Copy Section

Home > @google/generative-ai > CountTokensRequest

CountTokensRequest interface Copy Chapter

Params for calling GenerativeModel.countTokens().

The request must contain either a Content array or a GenerateContentRequest, but not both. If both are provided then a GoogleGenerativeAIRequestInputError is thrown.

Signature:

export interface CountTokensRequest

Properties Copy Chapter

Reference Main Generative Ai.Counttokensresponse (`docs/reference/main/generative-ai.counttokensresponse.md`) Copy Section

Home > @google/generative-ai > CountTokensResponse

CountTokensResponse interface Copy Chapter

Response from calling GenerativeModel.countTokens().

Signature:

export interface CountTokensResponse

Properties Copy Chapter

Reference Main Generative Ai.Counttokensresponse.Totaltokens (`docs/reference/main/generative-ai.counttokensresponse.totaltokens.md`) Copy Section

Home > @google/generative-ai > CountTokensResponse > totalTokens

CountTokensResponse.totalTokens property Copy Chapter

Signature:

totalTokens: number;

Reference Main Generative Ai.Dynamicretrievalconfig.Dynamicthreshold (`docs/reference/main/generative-ai.dynamicretrievalconfig.dynamicthreshold.md`) Copy Section

Home > @google/generative-ai > DynamicRetrievalConfig > dynamicThreshold

DynamicRetrievalConfig.dynamicThreshold property Copy Chapter

The threshold to be used in dynamic retrieval. If not set, a system default value is used.

Signature:

dynamicThreshold?: number;

Reference Main Generative Ai.Dynamicretrievalconfig (`docs/reference/main/generative-ai.dynamicretrievalconfig.md`) Copy Section

Home > @google/generative-ai > DynamicRetrievalConfig

DynamicRetrievalConfig interface Copy Chapter

Specifies the dynamic retrieval configuration for the given source.

Signature:

export declare interface DynamicRetrievalConfig

Properties Copy Chapter

Reference Main Generative Ai.Dynamicretrievalconfig.Mode (`docs/reference/main/generative-ai.dynamicretrievalconfig.mode.md`) Copy Section

Home > @google/generative-ai > DynamicRetrievalConfig > mode

DynamicRetrievalConfig.mode property Copy Chapter

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

Signature:

mode?: DynamicRetrievalMode;

Reference Main Generative Ai.Dynamicretrievalmode (`docs/reference/main/generative-ai.dynamicretrievalmode.md`) Copy Section

Home > @google/generative-ai > DynamicRetrievalMode

DynamicRetrievalMode enum Copy Chapter

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

Signature:

export declare enum DynamicRetrievalMode

Enumeration Members Copy Chapter

Reference Main Generative Ai.Embedcontentrequest.Content (`docs/reference/main/generative-ai.embedcontentrequest.content.md`) Copy Section

Home > @google/generative-ai > EmbedContentRequest > content

EmbedContentRequest.content property Copy Chapter

Signature:

content: Content;

Reference Main Generative Ai.Embedcontentrequest (`docs/reference/main/generative-ai.embedcontentrequest.md`) Copy Section

Home > @google/generative-ai > EmbedContentRequest

EmbedContentRequest interface Copy Chapter

Params for calling GenerativeModel.embedContent()

Signature:

export interface EmbedContentRequest

Properties Copy Chapter

Reference Main Generative Ai.Embedcontentrequest.Tasktype (`docs/reference/main/generative-ai.embedcontentrequest.tasktype.md`) Copy Section

Home > @google/generative-ai > EmbedContentRequest > taskType

EmbedContentRequest.taskType property Copy Chapter

Signature:

taskType?: TaskType;

Reference Main Generative Ai.Embedcontentrequest.Title (`docs/reference/main/generative-ai.embedcontentrequest.title.md`) Copy Section

Home > @google/generative-ai > EmbedContentRequest > title

EmbedContentRequest.title property Copy Chapter

Signature:

title?: string;

Reference Main Generative Ai.Embedcontentresponse.Embedding (`docs/reference/main/generative-ai.embedcontentresponse.embedding.md`) Copy Section

Home > @google/generative-ai > EmbedContentResponse > embedding

EmbedContentResponse.embedding property Copy Chapter

Signature:

embedding: ContentEmbedding;

Reference Main Generative Ai.Embedcontentresponse (`docs/reference/main/generative-ai.embedcontentresponse.md`) Copy Section

Home > @google/generative-ai > EmbedContentResponse

EmbedContentResponse interface Copy Chapter

Response from calling GenerativeModel.embedContent().

Signature:

export interface EmbedContentResponse

Properties Copy Chapter

Reference Main Generative Ai.Enhancedgeneratecontentresponse.Functioncall (`docs/reference/main/generative-ai.enhancedgeneratecontentresponse.functioncall.md`) Copy Section

Home > @google/generative-ai > EnhancedGenerateContentResponse > functionCall

EnhancedGenerateContentResponse.functionCall property Copy Chapter

Warning: This API is now obsolete.

• use functionCalls() instead

Deprecated: use functionCalls() instead.

Signature:

functionCall: () => FunctionCall | undefined;

Reference Main Generative Ai.Enhancedgeneratecontentresponse.Functioncalls (`docs/reference/main/generative-ai.enhancedgeneratecontentresponse.functioncalls.md`) Copy Section

Home > @google/generative-ai > EnhancedGenerateContentResponse > functionCalls

EnhancedGenerateContentResponse.functionCalls property Copy Chapter

Returns function calls found in any Parts of the first candidate of the response, if available. Throws if the prompt or candidate was blocked.

Signature:

functionCalls: () => FunctionCall[] | undefined;

Reference Main Generative Ai.Enhancedgeneratecontentresponse (`docs/reference/main/generative-ai.enhancedgeneratecontentresponse.md`) Copy Section

Home > @google/generative-ai > EnhancedGenerateContentResponse

EnhancedGenerateContentResponse interface Copy Chapter

Response object wrapped with helper methods.

Signature:

export interface EnhancedGenerateContentResponse extends GenerateContentResponse

Extends: GenerateContentResponse

Properties Copy Chapter

Reference Main Generative Ai.Enhancedgeneratecontentresponse.Text (`docs/reference/main/generative-ai.enhancedgeneratecontentresponse.text.md`) Copy Section

Home > @google/generative-ai > EnhancedGenerateContentResponse > text

EnhancedGenerateContentResponse.text property Copy Chapter

Returns the text string assembled from all Parts of the first candidate of the response, if available. Throws if the prompt or candidate was blocked.

Signature:

text: () => string;

Reference Main Generative Ai.Enumstringschema.Enum (`docs/reference/main/generative-ai.enumstringschema.enum.md`) Copy Section

Home > @google/generative-ai > EnumStringSchema > enum

EnumStringSchema.enum property Copy Chapter

Possible values for this enum

Signature:

enum: string[];

Reference Main Generative Ai.Enumstringschema.Format (`docs/reference/main/generative-ai.enumstringschema.format.md`) Copy Section

Home > @google/generative-ai > EnumStringSchema > format

EnumStringSchema.format property Copy Chapter

Signature:

format: "enum";

Reference Main Generative Ai.Enumstringschema (`docs/reference/main/generative-ai.enumstringschema.md`) Copy Section

Home > @google/generative-ai > EnumStringSchema

EnumStringSchema interface Copy Chapter

Describes a string enum

Signature:

export interface EnumStringSchema extends BaseSchema

Extends: BaseSchema

Properties Copy Chapter

Reference Main Generative Ai.Enumstringschema.Type (`docs/reference/main/generative-ai.enumstringschema.type.md`) Copy Section

Home > @google/generative-ai > EnumStringSchema > type

EnumStringSchema.type property Copy Chapter

Signature:

type: typeof SchemaType.STRING;

Reference Main Generative Ai.Errordetails. Type (`docs/reference/main/generative-ai.errordetails.__type_.md`) Copy Section

Home > @google/generative-ai > ErrorDetails > "@type"

ErrorDetails."@type" property Copy Chapter

Signature:

"@type"?: string;

Reference Main Generative Ai.Errordetails.Domain (`docs/reference/main/generative-ai.errordetails.domain.md`) Copy Section

Home > @google/generative-ai > ErrorDetails > domain

ErrorDetails.domain property Copy Chapter

Signature:

domain?: string;

Reference Main Generative Ai.Errordetails (`docs/reference/main/generative-ai.errordetails.md`) Copy Section

Home > @google/generative-ai > ErrorDetails

ErrorDetails interface Copy Chapter

Details object that may be included in an error response.

Signature:

export interface ErrorDetails

Properties Copy Chapter

Reference Main Generative Ai.Errordetails.Metadata (`docs/reference/main/generative-ai.errordetails.metadata.md`) Copy Section

Home > @google/generative-ai > ErrorDetails > metadata

ErrorDetails.metadata property Copy Chapter

Signature:

metadata?: Record<string, unknown>;

Reference Main Generative Ai.Errordetails.Reason (`docs/reference/main/generative-ai.errordetails.reason.md`) Copy Section

Home > @google/generative-ai > ErrorDetails > reason

ErrorDetails.reason property Copy Chapter

Signature:

reason?: string;

Reference Main Generative Ai.Executablecode.Code (`docs/reference/main/generative-ai.executablecode.code.md`) Copy Section

Home > @google/generative-ai > ExecutableCode > code

ExecutableCode.code property Copy Chapter

The code to be executed.

Signature:

code: string;

Reference Main Generative Ai.Executablecode.Language (`docs/reference/main/generative-ai.executablecode.language.md`) Copy Section

Home > @google/generative-ai > ExecutableCode > language

ExecutableCode.language property Copy Chapter

Programming language of the code.

Signature:

language: ExecutableCodeLanguage;

Reference Main Generative Ai.Executablecode (`docs/reference/main/generative-ai.executablecode.md`) Copy Section

Home > @google/generative-ai > ExecutableCode

ExecutableCode interface Copy Chapter

Code generated by the model that is meant to be executed, where the result is returned to the model. Only generated when using the code execution tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated.

Signature:

export interface ExecutableCode

Properties Copy Chapter

Reference Main Generative Ai.Executablecodelanguage (`docs/reference/main/generative-ai.executablecodelanguage.md`) Copy Section

Home > @google/generative-ai > ExecutableCodeLanguage

ExecutableCodeLanguage enum Copy Chapter

Signature:

export declare enum ExecutableCodeLanguage

Enumeration Members Copy Chapter

Reference Main Generative Ai.Executablecodepart.Codeexecutionresult (`docs/reference/main/generative-ai.executablecodepart.codeexecutionresult.md`) Copy Section

Home > @google/generative-ai > ExecutableCodePart > codeExecutionResult

ExecutableCodePart.codeExecutionResult property Copy Chapter

Signature:

codeExecutionResult?: never;

Reference Main Generative Ai.Executablecodepart.Executablecode (`docs/reference/main/generative-ai.executablecodepart.executablecode.md`) Copy Section

Home > @google/generative-ai > ExecutableCodePart > executableCode

ExecutableCodePart.executableCode property Copy Chapter

Signature:

executableCode: ExecutableCode;

Reference Main Generative Ai.Executablecodepart.Filedata (`docs/reference/main/generative-ai.executablecodepart.filedata.md`) Copy Section

Home > @google/generative-ai > ExecutableCodePart > fileData

ExecutableCodePart.fileData property Copy Chapter

Signature:

fileData?: never;

Reference Main Generative Ai.Executablecodepart.Functioncall (`docs/reference/main/generative-ai.executablecodepart.functioncall.md`) Copy Section

Home > @google/generative-ai > ExecutableCodePart > functionCall

ExecutableCodePart.functionCall property Copy Chapter

Signature:

functionCall?: never;

Reference Main Generative Ai.Executablecodepart.Functionresponse (`docs/reference/main/generative-ai.executablecodepart.functionresponse.md`) Copy Section

Home > @google/generative-ai > ExecutableCodePart > functionResponse

ExecutableCodePart.functionResponse property Copy Chapter

Signature:

functionResponse?: never;

Reference Main Generative Ai.Executablecodepart.Inlinedata (`docs/reference/main/generative-ai.executablecodepart.inlinedata.md`) Copy Section

Home > @google/generative-ai > ExecutableCodePart > inlineData

ExecutableCodePart.inlineData property Copy Chapter

Signature:

inlineData?: never;

Reference Main Generative Ai.Executablecodepart (`docs/reference/main/generative-ai.executablecodepart.md`) Copy Section

Home > @google/generative-ai > ExecutableCodePart

ExecutableCodePart interface Copy Chapter

Content part containing executable code generated by the model.

Signature:

export interface ExecutableCodePart

Properties Copy Chapter

Reference Main Generative Ai.Executablecodepart.Text (`docs/reference/main/generative-ai.executablecodepart.text.md`) Copy Section

Home > @google/generative-ai > ExecutableCodePart > text

ExecutableCodePart.text property Copy Chapter

Signature:

text?: never;

Reference Main Generative Ai.Filedata.Fileuri (`docs/reference/main/generative-ai.filedata.fileuri.md`) Copy Section

Home > @google/generative-ai > FileData > fileUri

FileData.fileUri property Copy Chapter

Signature:

fileUri: string;

Reference Main Generative Ai.Filedata (`docs/reference/main/generative-ai.filedata.md`) Copy Section

Home > @google/generative-ai > FileData

FileData interface Copy Chapter

Data pointing to a file uploaded with the Files API.

Signature:

export interface FileData

Properties Copy Chapter

Reference Main Generative Ai.Filedata.Mimetype (`docs/reference/main/generative-ai.filedata.mimetype.md`) Copy Section

Home > @google/generative-ai > FileData > mimeType

FileData.mimeType property Copy Chapter

Signature:

mimeType: string;

Reference Main Generative Ai.Filedatapart.Codeexecutionresult (`docs/reference/main/generative-ai.filedatapart.codeexecutionresult.md`) Copy Section

Home > @google/generative-ai > FileDataPart > codeExecutionResult

FileDataPart.codeExecutionResult property Copy Chapter

Signature:

codeExecutionResult?: never;

Reference Main Generative Ai.Filedatapart.Executablecode (`docs/reference/main/generative-ai.filedatapart.executablecode.md`) Copy Section

Home > @google/generative-ai > FileDataPart > executableCode

FileDataPart.executableCode property Copy Chapter

Signature:

executableCode?: never;

Reference Main Generative Ai.Filedatapart.Filedata (`docs/reference/main/generative-ai.filedatapart.filedata.md`) Copy Section

Home > @google/generative-ai > FileDataPart > fileData

FileDataPart.fileData property Copy Chapter

Signature:

fileData: FileData;

Reference Main Generative Ai.Filedatapart.Functioncall (`docs/reference/main/generative-ai.filedatapart.functioncall.md`) Copy Section

Home > @google/generative-ai > FileDataPart > functionCall

FileDataPart.functionCall property Copy Chapter

Signature:

functionCall?: never;

Reference Main Generative Ai.Filedatapart.Functionresponse (`docs/reference/main/generative-ai.filedatapart.functionresponse.md`) Copy Section

Home > @google/generative-ai > FileDataPart > functionResponse

FileDataPart.functionResponse property Copy Chapter

Signature:

functionResponse?: never;

Reference Main Generative Ai.Filedatapart.Inlinedata (`docs/reference/main/generative-ai.filedatapart.inlinedata.md`) Copy Section

Home > @google/generative-ai > FileDataPart > inlineData

FileDataPart.inlineData property Copy Chapter

Signature:

inlineData?: never;

Reference Main Generative Ai.Filedatapart (`docs/reference/main/generative-ai.filedatapart.md`) Copy Section

Home > @google/generative-ai > FileDataPart

FileDataPart interface Copy Chapter

Content part interface if the part represents FileData.

Signature:

export interface FileDataPart

Properties Copy Chapter

Reference Main Generative Ai.Filedatapart.Text (`docs/reference/main/generative-ai.filedatapart.text.md`) Copy Section

Home > @google/generative-ai > FileDataPart > text

FileDataPart.text property Copy Chapter

Signature:

text?: never;

Reference Main Generative Ai.Finishreason (`docs/reference/main/generative-ai.finishreason.md`) Copy Section

Home > @google/generative-ai > FinishReason

FinishReason enum Copy Chapter

Reason that a candidate finished.

Signature:

export declare enum FinishReason

Enumeration Members Copy Chapter

Reference Main Generative Ai.Functioncall.Args (`docs/reference/main/generative-ai.functioncall.args.md`) Copy Section

Home > @google/generative-ai > FunctionCall > args

FunctionCall.args property Copy Chapter

Signature:

args: object;

Reference Main Generative Ai.Functioncall (`docs/reference/main/generative-ai.functioncall.md`) Copy Section

Home > @google/generative-ai > FunctionCall

FunctionCall interface Copy Chapter

A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.

Signature:

export interface FunctionCall

Properties Copy Chapter

Reference Main Generative Ai.Functioncall.Name (`docs/reference/main/generative-ai.functioncall.name.md`) Copy Section

Home > @google/generative-ai > FunctionCall > name

FunctionCall.name property Copy Chapter

Signature:

name: string;

Reference Main Generative Ai.Functioncallingconfig.Allowedfunctionnames (`docs/reference/main/generative-ai.functioncallingconfig.allowedfunctionnames.md`) Copy Section

Home > @google/generative-ai > FunctionCallingConfig > allowedFunctionNames

FunctionCallingConfig.allowedFunctionNames property Copy Chapter

Signature:

allowedFunctionNames?: string[];

Reference Main Generative Ai.Functioncallingconfig (`docs/reference/main/generative-ai.functioncallingconfig.md`) Copy Section

Home > @google/generative-ai > FunctionCallingConfig

FunctionCallingConfig interface Copy Chapter

Signature:

export interface FunctionCallingConfig

Properties Copy Chapter

Reference Main Generative Ai.Functioncallingconfig.Mode (`docs/reference/main/generative-ai.functioncallingconfig.mode.md`) Copy Section

Home > @google/generative-ai > FunctionCallingConfig > mode

FunctionCallingConfig.mode property Copy Chapter

Signature:

mode?: FunctionCallingMode;

Reference Main Generative Ai.Functioncallingmode (`docs/reference/main/generative-ai.functioncallingmode.md`) Copy Section

Home > @google/generative-ai > FunctionCallingMode

FunctionCallingMode enum Copy Chapter

Signature:

export declare enum FunctionCallingMode

Enumeration Members Copy Chapter

Reference Main Generative Ai.Functioncallpart.Codeexecutionresult (`docs/reference/main/generative-ai.functioncallpart.codeexecutionresult.md`) Copy Section

Home > @google/generative-ai > FunctionCallPart > codeExecutionResult

FunctionCallPart.codeExecutionResult property Copy Chapter

Signature:

codeExecutionResult?: never;

Reference Main Generative Ai.Functioncallpart.Executablecode (`docs/reference/main/generative-ai.functioncallpart.executablecode.md`) Copy Section

Home > @google/generative-ai > FunctionCallPart > executableCode

FunctionCallPart.executableCode property Copy Chapter

Signature:

executableCode?: never;

Reference Main Generative Ai.Functioncallpart.Filedata (`docs/reference/main/generative-ai.functioncallpart.filedata.md`) Copy Section

Home > @google/generative-ai > FunctionCallPart > fileData

FunctionCallPart.fileData property Copy Chapter

Signature:

fileData?: never;

Reference Main Generative Ai.Functioncallpart.Functioncall (`docs/reference/main/generative-ai.functioncallpart.functioncall.md`) Copy Section

Home > @google/generative-ai > FunctionCallPart > functionCall

FunctionCallPart.functionCall property Copy Chapter

Signature:

functionCall: FunctionCall;

Reference Main Generative Ai.Functioncallpart.Functionresponse (`docs/reference/main/generative-ai.functioncallpart.functionresponse.md`) Copy Section

Home > @google/generative-ai > FunctionCallPart > functionResponse

FunctionCallPart.functionResponse property Copy Chapter

Signature:

functionResponse?: never;

Reference Main Generative Ai.Functioncallpart.Inlinedata (`docs/reference/main/generative-ai.functioncallpart.inlinedata.md`) Copy Section

Home > @google/generative-ai > FunctionCallPart > inlineData

FunctionCallPart.inlineData property Copy Chapter

Signature:

inlineData?: never;

Reference Main Generative Ai.Functioncallpart (`docs/reference/main/generative-ai.functioncallpart.md`) Copy Section

Home > @google/generative-ai > FunctionCallPart

FunctionCallPart interface Copy Chapter

Content part interface if the part represents a FunctionCall.

Signature:

export interface FunctionCallPart

Properties Copy Chapter

Reference Main Generative Ai.Functioncallpart.Text (`docs/reference/main/generative-ai.functioncallpart.text.md`) Copy Section

Home > @google/generative-ai > FunctionCallPart > text

FunctionCallPart.text property Copy Chapter

Signature:

text?: never;

Reference Main Generative Ai.Functiondeclaration.Description (`docs/reference/main/generative-ai.functiondeclaration.description.md`) Copy Section

Home > @google/generative-ai > FunctionDeclaration > description

FunctionDeclaration.description property Copy Chapter

Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.

Signature:

description?: string;

Reference Main Generative Ai.Functiondeclaration (`docs/reference/main/generative-ai.functiondeclaration.md`) Copy Section

Home > @google/generative-ai > FunctionDeclaration

FunctionDeclaration interface Copy Chapter

Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a Tool by the model and executed by the client.

Signature:

export declare interface FunctionDeclaration

Properties Copy Chapter

Reference Main Generative Ai.Functiondeclaration.Name (`docs/reference/main/generative-ai.functiondeclaration.name.md`) Copy Section

Home > @google/generative-ai > FunctionDeclaration > name

FunctionDeclaration.name property Copy Chapter

The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a max length of 64.

Signature:

name: string;

Reference Main Generative Ai.Functiondeclaration.Parameters (`docs/reference/main/generative-ai.functiondeclaration.parameters.md`) Copy Section

Home > @google/generative-ai > FunctionDeclaration > parameters

FunctionDeclaration.parameters property Copy Chapter

Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset.

Signature:

parameters?: FunctionDeclarationSchema;

Example Copy Chapter

with 1 required and 1 optional parameter: type: OBJECT properties:

param1:

  type: STRING
param2:

 type: INTEGER
required:

  - param1

Reference Main Generative Ai.Functiondeclarationschema.Description (`docs/reference/main/generative-ai.functiondeclarationschema.description.md`) Copy Section

Home > @google/generative-ai > FunctionDeclarationSchema > description

FunctionDeclarationSchema.description property Copy Chapter

Optional. Description of the parameter.

Signature:

description?: string;

Reference Main Generative Ai.Functiondeclarationschema (`docs/reference/main/generative-ai.functiondeclarationschema.md`) Copy Section

Home > @google/generative-ai > FunctionDeclarationSchema

FunctionDeclarationSchema interface Copy Chapter

Schema for parameters passed to FunctionDeclaration.parameters.

Signature:

export interface FunctionDeclarationSchema

Properties Copy Chapter

Reference Main Generative Ai.Functiondeclarationschema.Properties (`docs/reference/main/generative-ai.functiondeclarationschema.properties.md`) Copy Section

Home > @google/generative-ai > FunctionDeclarationSchema > properties

FunctionDeclarationSchema.properties property Copy Chapter

The format of the parameter.

Signature:

properties: {
        [k: string]: FunctionDeclarationSchemaProperty;
    };

Reference Main Generative Ai.Functiondeclarationschema.Required (`docs/reference/main/generative-ai.functiondeclarationschema.required.md`) Copy Section

Home > @google/generative-ai > FunctionDeclarationSchema > required

FunctionDeclarationSchema.required property Copy Chapter

Optional. Array of required parameters.

Signature:

required?: string[];

Reference Main Generative Ai.Functiondeclarationschema.Type (`docs/reference/main/generative-ai.functiondeclarationschema.type.md`) Copy Section

Home > @google/generative-ai > FunctionDeclarationSchema > type

FunctionDeclarationSchema.type property Copy Chapter

The type of the parameter.

Signature:

type: SchemaType;

Reference Main Generative Ai.Functiondeclarationschemaproperty (`docs/reference/main/generative-ai.functiondeclarationschemaproperty.md`) Copy Section

Home > @google/generative-ai > FunctionDeclarationSchemaProperty

FunctionDeclarationSchemaProperty type Copy Chapter

Schema for top-level function declaration

Signature:

export type FunctionDeclarationSchemaProperty = Schema;

References: Schema

Reference Main Generative Ai.Functiondeclarationstool.Functiondeclarations (`docs/reference/main/generative-ai.functiondeclarationstool.functiondeclarations.md`) Copy Section

Home > @google/generative-ai > FunctionDeclarationsTool > functionDeclarations

FunctionDeclarationsTool.functionDeclarations property Copy Chapter

Optional. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating [FunctionCall][content.part.functionCall] in the response. User should provide a [FunctionResponse][content.part.functionResponse] for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided.

Signature:

functionDeclarations?: FunctionDeclaration[];

Reference Main Generative Ai.Functiondeclarationstool (`docs/reference/main/generative-ai.functiondeclarationstool.md`) Copy Section

Home > @google/generative-ai > FunctionDeclarationsTool

FunctionDeclarationsTool interface Copy Chapter

A FunctionDeclarationsTool 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.

Signature:

export declare interface FunctionDeclarationsTool

Properties Copy Chapter

Reference Main Generative Ai.Functionresponse (`docs/reference/main/generative-ai.functionresponse.md`) Copy Section

Home > @google/generative-ai > FunctionResponse

FunctionResponse interface Copy Chapter

The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction.

Signature:

export interface FunctionResponse

Properties Copy Chapter

Reference Main Generative Ai.Functionresponse.Name (`docs/reference/main/generative-ai.functionresponse.name.md`) Copy Section

Home > @google/generative-ai > FunctionResponse > name

FunctionResponse.name property Copy Chapter

Signature:

name: string;

Reference Main Generative Ai.Functionresponse.Response (`docs/reference/main/generative-ai.functionresponse.response.md`) Copy Section

Home > @google/generative-ai > FunctionResponse > response

FunctionResponse.response property Copy Chapter

Signature:

response: object;

Reference Main Generative Ai.Functionresponsepart.Codeexecutionresult (`docs/reference/main/generative-ai.functionresponsepart.codeexecutionresult.md`) Copy Section

Home > @google/generative-ai > FunctionResponsePart > codeExecutionResult

FunctionResponsePart.codeExecutionResult property Copy Chapter

Signature:

codeExecutionResult?: never;

Reference Main Generative Ai.Functionresponsepart.Executablecode (`docs/reference/main/generative-ai.functionresponsepart.executablecode.md`) Copy Section

Home > @google/generative-ai > FunctionResponsePart > executableCode

FunctionResponsePart.executableCode property Copy Chapter

Signature:

executableCode?: never;

Reference Main Generative Ai.Functionresponsepart.Filedata (`docs/reference/main/generative-ai.functionresponsepart.filedata.md`) Copy Section

Home > @google/generative-ai > FunctionResponsePart > fileData

FunctionResponsePart.fileData property Copy Chapter

Signature:

fileData?: never;

Reference Main Generative Ai.Functionresponsepart.Functioncall (`docs/reference/main/generative-ai.functionresponsepart.functioncall.md`) Copy Section

Home > @google/generative-ai > FunctionResponsePart > functionCall

FunctionResponsePart.functionCall property Copy Chapter

Signature:

functionCall?: never;

Reference Main Generative Ai.Functionresponsepart.Functionresponse (`docs/reference/main/generative-ai.functionresponsepart.functionresponse.md`) Copy Section

Home > @google/generative-ai > FunctionResponsePart > functionResponse

FunctionResponsePart.functionResponse property Copy Chapter

Signature:

functionResponse: FunctionResponse;

Reference Main Generative Ai.Functionresponsepart.Inlinedata (`docs/reference/main/generative-ai.functionresponsepart.inlinedata.md`) Copy Section

Home > @google/generative-ai > FunctionResponsePart > inlineData

FunctionResponsePart.inlineData property Copy Chapter

Signature:

inlineData?: never;

Reference Main Generative Ai.Functionresponsepart (`docs/reference/main/generative-ai.functionresponsepart.md`) Copy Section

Home > @google/generative-ai > FunctionResponsePart

FunctionResponsePart interface Copy Chapter

Content part interface if the part represents FunctionResponse.

Signature:

export interface FunctionResponsePart

Properties Copy Chapter

Reference Main Generative Ai.Functionresponsepart.Text (`docs/reference/main/generative-ai.functionresponsepart.text.md`) Copy Section

Home > @google/generative-ai > FunctionResponsePart > text

FunctionResponsePart.text property Copy Chapter

Signature:

text?: never;

Reference Main Generative Ai.Generatecontentcandidate.Avglogprobs (`docs/reference/main/generative-ai.generatecontentcandidate.avglogprobs.md`) Copy Section

Home > @google/generative-ai > GenerateContentCandidate > avgLogprobs

GenerateContentCandidate.avgLogprobs property Copy Chapter

Average log probability score of the candidate.

Signature:

avgLogprobs?: number;

Reference Main Generative Ai.Generatecontentcandidate.Citationmetadata (`docs/reference/main/generative-ai.generatecontentcandidate.citationmetadata.md`) Copy Section

Home > @google/generative-ai > GenerateContentCandidate > citationMetadata

GenerateContentCandidate.citationMetadata property Copy Chapter

Signature:

citationMetadata?: CitationMetadata;

Reference Main Generative Ai.Generatecontentcandidate.Content (`docs/reference/main/generative-ai.generatecontentcandidate.content.md`) Copy Section

Home > @google/generative-ai > GenerateContentCandidate > content

GenerateContentCandidate.content property Copy Chapter

Signature:

content: Content;

Reference Main Generative Ai.Generatecontentcandidate.Finishmessage (`docs/reference/main/generative-ai.generatecontentcandidate.finishmessage.md`) Copy Section

Home > @google/generative-ai > GenerateContentCandidate > finishMessage

GenerateContentCandidate.finishMessage property Copy Chapter

Signature:

finishMessage?: string;

Reference Main Generative Ai.Generatecontentcandidate.Finishreason (`docs/reference/main/generative-ai.generatecontentcandidate.finishreason.md`) Copy Section

Home > @google/generative-ai > GenerateContentCandidate > finishReason

GenerateContentCandidate.finishReason property Copy Chapter

Signature:

finishReason?: FinishReason;

Reference Main Generative Ai.Generatecontentcandidate.Groundingmetadata (`docs/reference/main/generative-ai.generatecontentcandidate.groundingmetadata.md`) Copy Section

Home > @google/generative-ai > GenerateContentCandidate > groundingMetadata

GenerateContentCandidate.groundingMetadata property Copy Chapter

Search grounding metadata.

Signature:

groundingMetadata?: GroundingMetadata;

Reference Main Generative Ai.Generatecontentcandidate.Logprobsresult (`docs/reference/main/generative-ai.generatecontentcandidate.logprobsresult.md`) Copy Section

Home > @google/generative-ai > GenerateContentCandidate > logprobsResult

GenerateContentCandidate.logprobsResult property Copy Chapter

Log-likelihood scores for the response tokens and top tokens.

Signature:

logprobsResult?: LogprobsResult;

Reference Main Generative Ai.Generatecontentcandidate (`docs/reference/main/generative-ai.generatecontentcandidate.md`) Copy Section

Home > @google/generative-ai > GenerateContentCandidate

GenerateContentCandidate interface Copy Chapter

A candidate returned as part of a GenerateContentResponse.

Signature:

export interface GenerateContentCandidate

Properties Copy Chapter

Reference Main Generative Ai.Generatecontentcandidate.Safetyratings (`docs/reference/main/generative-ai.generatecontentcandidate.safetyratings.md`) Copy Section

Home > @google/generative-ai > GenerateContentCandidate > safetyRatings

GenerateContentCandidate.safetyRatings property Copy Chapter

Signature:

safetyRatings?: SafetyRating[];

Reference Main Generative Ai.Generatecontentrequest.Cachedcontent (`docs/reference/main/generative-ai.generatecontentrequest.cachedcontent.md`) Copy Section

Home > @google/generative-ai > GenerateContentRequest > cachedContent

GenerateContentRequest.cachedContent property Copy Chapter

This is the name of a CachedContent and not the cache object itself.

Signature:

cachedContent?: string;

Reference Main Generative Ai.Generatecontentrequest.Contents (`docs/reference/main/generative-ai.generatecontentrequest.contents.md`) Copy Section

Home > @google/generative-ai > GenerateContentRequest > contents

GenerateContentRequest.contents property Copy Chapter

Signature:

contents: Content[];

Reference Main Generative Ai.Generatecontentrequest (`docs/reference/main/generative-ai.generatecontentrequest.md`) Copy Section

Home > @google/generative-ai > GenerateContentRequest

GenerateContentRequest interface Copy Chapter

Request sent to generateContent endpoint.

Signature:

export interface GenerateContentRequest extends BaseParams

Extends: BaseParams

Properties Copy Chapter

Reference Main Generative Ai.Generatecontentrequest.Systeminstruction (`docs/reference/main/generative-ai.generatecontentrequest.systeminstruction.md`) Copy Section

Home > @google/generative-ai > GenerateContentRequest > systemInstruction

GenerateContentRequest.systemInstruction property Copy Chapter

Signature:

systemInstruction?: string | Part | Content;

Reference Main Generative Ai.Generatecontentrequest.Toolconfig (`docs/reference/main/generative-ai.generatecontentrequest.toolconfig.md`) Copy Section

Home > @google/generative-ai > GenerateContentRequest > toolConfig

GenerateContentRequest.toolConfig property Copy Chapter

Signature:

toolConfig?: ToolConfig;

Reference Main Generative Ai.Generatecontentrequest.Tools (`docs/reference/main/generative-ai.generatecontentrequest.tools.md`) Copy Section

Home > @google/generative-ai > GenerateContentRequest > tools

GenerateContentRequest.tools property Copy Chapter

Signature:

tools?: Tool[];

Reference Main Generative Ai.Generatecontentresponse.Candidates (`docs/reference/main/generative-ai.generatecontentresponse.candidates.md`) Copy Section

Home > @google/generative-ai > GenerateContentResponse > candidates

GenerateContentResponse.candidates property Copy Chapter

Candidate responses from the model.

Signature:

candidates?: GenerateContentCandidate[];

Reference Main Generative Ai.Generatecontentresponse (`docs/reference/main/generative-ai.generatecontentresponse.md`) Copy Section

Home > @google/generative-ai > GenerateContentResponse

GenerateContentResponse interface Copy Chapter