Package dev.langchain4j.model.vertexai

Class VertexAiChatModel

java.lang.Object

dev.langchain4j.model.vertexai.VertexAiChatModel

All Implemented Interfaces:

ChatLanguageModel

public class VertexAiChatModel
extends Object
implements ChatLanguageModel

Represents a Google Vertex AI language model with a chat completion interface, such as chat-bison. See details here.
Please follow these steps before using this model:
1. Authentication
When developing locally, you can use one of:
a) Google Cloud SDK
b) Service account When using service account, ensure that GOOGLE_APPLICATION_CREDENTIALS environment variable points to your JSON service account key.
2. Authorization
3. Prerequisites

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VertexAiChatModel.Builder

Constructor Summary

Constructors

Constructor	Description
VertexAiChatModel(String endpoint, String project, String location, String publisher, String modelName, Double temperature, Integer maxOutputTokens, Integer topK, Double topP, Integer maxRetries)

Method Summary

Modifier and Type	Method	Description
static VertexAiChatModel.Builder	builder()
ChatResponse	chat(ChatRequest chatRequest)	This is the main API to interact with the chat model.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.langchain4j.model.chat.ChatLanguageModel

chat, chat, chat, defaultRequestParameters, doChat, listeners, provider, supportedCapabilities

Constructor Details

VertexAiChatModel

public VertexAiChatModel(String endpoint,
 String project,
 String location,
 String publisher,
 String modelName,
 Double temperature,
 Integer maxOutputTokens,
 Integer topK,
 Double topP,
 Integer maxRetries)

Method Details

chat

public ChatResponse chat(ChatRequest chatRequest)

Description copied from interface: ChatLanguageModel

This is the main API to interact with the chat model. A temporary default implementation of this method is necessary until all ChatLanguageModel implementations adopt it. It should be removed once that occurs.

Specified by:

chat in interface ChatLanguageModel

Parameters:

chatRequest - a ChatRequest, containing all the inputs to the LLM

Returns:

a ChatResponse, containing all the outputs from the LLM

builder

public static VertexAiChatModel.Builder builder()