!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())

[Skip to main content](#__docusaurus_skipToContent_fallback)

You are viewing the **preview** v0.2 docs. View the **stable** v0.1 docs [here](/v0.1/docs/get_started/introduction/). Leave feedback on the v0.2 docs [here](https://github.com/langchain-ai/langchainjs/discussions/5386).

[

![🦜️🔗 Langchain](/v0.2/img/brand/wordmark.png)![🦜️🔗 Langchain](/v0.2/img/brand/wordmark-dark.png)

](/v0.2/)[Integrations](/v0.2/docs/integrations/platforms/)[API Reference](https://v02.api.js.langchain.com)

[More](#)

*   [People](/v0.2/docs/people/)
*   [Community](/v0.2/docs/community)
*   [Tutorials](/v0.2/docs/additional_resources/tutorials)
*   [Contributing](/v0.2/docs/contributing)

[v0.2](#)

*   [v0.2](/v0.2/docs/introduction)
*   [v0.1](https://js.langchain.com/v0.1/docs/get_started/introduction)

[🦜🔗](#)

*   [LangSmith](https://smith.langchain.com)
*   [LangSmith Docs](https://docs.smith.langchain.com)
*   [LangChain Hub](https://smith.langchain.com/hub)
*   [LangServe](https://github.com/langchain-ai/langserve)
*   [Python Docs](https://python.langchain.com/)

[Chat](https://chatjs.langchain.com)[](https://github.com/langchain-ai/langchainjs)

Search

*   [Providers](/v0.2/docs/integrations/platforms/)
    
    *   [Providers](/v0.2/docs/integrations/platforms/)
    *   [Anthropic](/v0.2/docs/integrations/platforms/anthropic)
    *   [AWS](/v0.2/docs/integrations/platforms/aws)
    *   [Google](/v0.2/docs/integrations/platforms/google)
    *   [Microsoft](/v0.2/docs/integrations/platforms/microsoft)
    *   [OpenAI](/v0.2/docs/integrations/platforms/openai)
*   [Components](/v0.2/docs/integrations/components)
    
    *   [Chat models](/v0.2/docs/integrations/chat/)
        
    *   [LLMs](/v0.2/docs/integrations/llms/)
        
        *   [LLMs](/v0.2/docs/integrations/llms/)
        *   [AI21](/v0.2/docs/integrations/llms/ai21)
        *   [AlephAlpha](/v0.2/docs/integrations/llms/aleph_alpha)
        *   [AWS SageMakerEndpoint](/v0.2/docs/integrations/llms/aws_sagemaker)
        *   [Azure OpenAI](/v0.2/docs/integrations/llms/azure)
        *   [Bedrock](/v0.2/docs/integrations/llms/bedrock)
        *   [Cloudflare Workers AI](/v0.2/docs/integrations/llms/cloudflare_workersai)
        *   [Cohere](/v0.2/docs/integrations/llms/cohere)
        *   [Fireworks](/v0.2/docs/integrations/llms/fireworks)
        *   [Friendli](/v0.2/docs/integrations/llms/friendli)
        *   [(Legacy) Google PaLM/VertexAI](/v0.2/docs/integrations/llms/google_palm)
        *   [Google Vertex AI](/v0.2/docs/integrations/llms/google_vertex_ai)
        *   [Gradient AI](/v0.2/docs/integrations/llms/gradient_ai)
        *   [HuggingFaceInference](/v0.2/docs/integrations/llms/huggingface_inference)
        *   [Llama CPP](/v0.2/docs/integrations/llms/llama_cpp)
        *   [NIBittensor](/v0.2/docs/integrations/llms/ni_bittensor)
        *   [Ollama](/v0.2/docs/integrations/llms/ollama)
        *   [OpenAI](/v0.2/docs/integrations/llms/openai)
        *   [PromptLayer OpenAI](/v0.2/docs/integrations/llms/prompt_layer_openai)
        *   [RaycastAI](/v0.2/docs/integrations/llms/raycast)
        *   [Replicate](/v0.2/docs/integrations/llms/replicate)
        *   [Together AI](/v0.2/docs/integrations/llms/togetherai)
        *   [WatsonX AI](/v0.2/docs/integrations/llms/watsonx_ai)
        *   [Writer](/v0.2/docs/integrations/llms/writer)
        *   [YandexGPT](/v0.2/docs/integrations/llms/yandex)
    *   [Embedding models](/v0.2/docs/integrations/text_embedding)
        
    *   [Document loaders](/v0.2/docs/integrations/document_loaders)
        
    *   [Document transformers](/v0.2/docs/integrations/document_transformers)
        
    *   [Vector stores](/v0.2/docs/integrations/vectorstores)
        
    *   [Retrievers](/v0.2/docs/integrations/retrievers)
        
    *   [Tools](/v0.2/docs/integrations/tools)
        
    *   [Toolkits](/v0.2/docs/integrations/toolkits)
        
    *   [Stores](/v0.2/docs/integrations/stores/)
        

*   [](/v0.2/)
*   [Components](/v0.2/docs/integrations/components)
*   [LLMs](/v0.2/docs/integrations/llms/)
*   Google Vertex AI

On this page

Google Vertex AI
================

Langchain.js supports two different authentication methods based on whether you're running in a Node.js environment or a web environment.

Setup[​](#setup "Direct link to Setup")
---------------------------------------

### Node.js[​](#nodejs "Direct link to Node.js")

To call Vertex AI models in Node, you'll need to install the `@langchain/google-vertexai` package:

tip

See [this section for general instructions on installing integration packages](/v0.2/docs/how_to/installation#installing-integration-packages).

*   npm
*   Yarn
*   pnpm

    npm install @langchain/google-vertexai

    yarn add @langchain/google-vertexai

    pnpm add @langchain/google-vertexai

You should make sure the Vertex AI API is enabled for the relevant project and that you've authenticated to Google Cloud using one of these methods:

*   You are logged into an account (using `gcloud auth application-default login`) permitted to that project.
*   You are running on a machine using a service account that is permitted to the project.
*   You have downloaded the credentials for a service account that is permitted to the project and set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to the path of this file. **or**
*   You set the `GOOGLE_API_KEY` environment variable to the API key for the project.

### Web[​](#web "Direct link to Web")

To call Vertex AI models in web environments (like Edge functions), you'll need to install the `@langchain/google-vertexai-web` package:

*   npm
*   Yarn
*   pnpm

    npm install @langchain/google-vertexai-web

    yarn add @langchain/google-vertexai-web

    pnpm add @langchain/google-vertexai-web

Then, you'll need to add your service account credentials directly as a `GOOGLE_VERTEX_AI_WEB_CREDENTIALS` environment variable:

    GOOGLE_VERTEX_AI_WEB_CREDENTIALS={"type":"service_account","project_id":"YOUR_PROJECT-12345",...}

You can also pass your credentials directly in code like this:

    import { VertexAI } from "@langchain/google-vertexai";// Or uncomment this line if you're using the web version:// import { VertexAI } from "@langchain/google-vertexai-web";const model = new VertexAI({  authOptions: {    credentials: {"type":"service_account","project_id":"YOUR_PROJECT-12345",...},  },});

Usage[​](#usage "Direct link to Usage")
---------------------------------------

The entire family of `gemini` models are available by specifying the `modelName` parameter.

    import { VertexAI } from "@langchain/google-vertexai";// Or, if using the web entrypoint:// import { VertexAI } from "@langchain/google-vertexai-web";const model = new VertexAI({  temperature: 0.7,});const res = await model.invoke(  "What would be a good company name for a company that makes colorful socks?");console.log({ res });/*{  res: '* Hue Hues\n' +    '* Sock Spectrum\n' +    '* Kaleidosocks\n' +    '* Threads of Joy\n' +    '* Vibrant Threads\n' +    '* Rainbow Soles\n' +    '* Colorful Canvases\n' +    '* Prismatic Pedals\n' +    '* Sock Canvas\n' +    '* Color Collective'} */

#### API Reference:

*   [VertexAI](https://v02.api.js.langchain.com/classes/langchain_google_vertexai.VertexAI.html) from `@langchain/google-vertexai`

### Streaming[​](#streaming "Direct link to Streaming")

Streaming in multiple chunks is supported for faster responses:

    import { VertexAI } from "@langchain/google-vertexai";// Or, if using the web entrypoint:// import { VertexAI } from "@langchain/google-vertexai-web";const model = new VertexAI({  temperature: 0.7,});const stream = await model.stream(  "What would be a good company name for a company that makes colorful socks?");for await (const chunk of stream) {  console.log("\n---------\nChunk:\n---------\n", chunk);}/*---------Chunk:--------- * Kaleidoscope Toes* Huephoria* Soleful Spectrum*---------Chunk:---------  Colorwave Hosiery* Chromatic Threads* Rainbow Rhapsody* Vibrant Soles* Toe-tally Colorful* Socktacular Hues*---------Chunk:---------  Threads of Joy---------Chunk:---------*/

#### API Reference:

*   [VertexAI](https://v02.api.js.langchain.com/classes/langchain_google_vertexai.VertexAI.html) from `@langchain/google-vertexai`

* * *

#### Was this page helpful?

  

#### You can leave detailed feedback [on GitHub](https://github.com/langchain-ai/langchainjs/issues/new?assignees=&labels=03+-+Documentation&projects=&template=documentation.yml&title=DOC%3A+%3CPlease+write+a+comprehensive+title+after+the+%27DOC%3A+%27+prefix%3E).

[

Previous

(Legacy) Google PaLM/VertexAI

](/v0.2/docs/integrations/llms/google_palm)[

Next

Gradient AI

](/v0.2/docs/integrations/llms/gradient_ai)

*   [Setup](#setup)
    *   [Node.js](#nodejs)
    *   [Web](#web)
*   [Usage](#usage)
    *   [Streaming](#streaming)

Community

*   [Discord](https://discord.gg/cU2adEyC7w)
*   [Twitter](https://twitter.com/LangChainAI)

GitHub

*   [Python](https://github.com/langchain-ai/langchain)
*   [JS/TS](https://github.com/langchain-ai/langchainjs)

More

*   [Homepage](https://langchain.com)
*   [Blog](https://blog.langchain.dev)

Copyright © 2024 LangChain, Inc.