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()
Response<AiMessage>	generate(List<ChatMessage> messages)	Generates a response from the model based on a sequence of messages.

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, generate, generate, generate, generate, 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

generate

public Response<AiMessage> generate(List<ChatMessage> messages)

Description copied from interface: ChatLanguageModel

Generates a response from the model based on a sequence of messages. Typically, the sequence contains messages in the following order: System (optional) - User - AI - User - AI - User ...

Specified by:

generate in interface ChatLanguageModel

Parameters:

messages - A list of messages.

Returns:

The response generated by the model.

builder

public static VertexAiChatModel.Builder builder()