Class VertexAiChatModel

java.lang.Object

dev.langchain4j.model.vertexai.VertexAiChatModel

All Implemented Interfaces:

ChatModel

public class VertexAiChatModel
extends Object
implements ChatModel

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(VertexAiChatModel.Builder builder)
VertexAiChatModel(String endpoint, String project, String location, String publisher, String modelName, Double temperature, Integer maxOutputTokens, Integer topK, Double topP, Integer maxRetries)	Deprecated, for removal: This API element is subject to removal in a future version. Please use VertexAiChatModel(Builder) instead

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 Object

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

Methods inherited from interface ChatModel

chat, chat, chat, chat, chatAsync, chatAsync, chatAsync, chatAsync, chatAsync, defaultRequestParameters, doChat, doChatAsync, listeners, provider, supportedCapabilities

Constructor Details

VertexAiChatModel

public VertexAiChatModel(VertexAiChatModel.Builder builder)

VertexAiChatModel

@Deprecated(forRemoval=true,
            since="1.2.0")
public VertexAiChatModel(String endpoint,
 String project,
 String location,
 String publisher,
 String modelName,
 Double temperature,
 Integer maxOutputTokens,
 Integer topK,
 Double topP,
 Integer maxRetries)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use VertexAiChatModel(Builder) instead

Method Details

chat

public ChatResponse chat(ChatRequest chatRequest)

Description copied from interface: ChatModel

This is the main API to interact with the chat model.

Specified by:

chat in interface ChatModel

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()