Package dev.langchain4j.model.huggingface

Class HuggingFaceChatModel

java.lang.Object

dev.langchain4j.model.huggingface.HuggingFaceChatModel

All Implemented Interfaces:

ChatLanguageModel

public class HuggingFaceChatModel
extends Object
implements ChatLanguageModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HuggingFaceChatModel.Builder

Constructor Summary

Constructors

Constructor	Description
HuggingFaceChatModel(HuggingFaceChatModel.Builder builder)
HuggingFaceChatModel(String baseUrl, String accessToken, String modelId, Duration timeout, Double temperature, Integer maxNewTokens, Boolean returnFullText, Boolean waitForModel)
HuggingFaceChatModel(String accessToken, String modelId, Duration timeout, Double temperature, Integer maxNewTokens, Boolean returnFullText, Boolean waitForModel)

Method Summary

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

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

HuggingFaceChatModel

public HuggingFaceChatModel(String accessToken,
 String modelId,
 Duration timeout,
 Double temperature,
 Integer maxNewTokens,
 Boolean returnFullText,
 Boolean waitForModel)

HuggingFaceChatModel

public HuggingFaceChatModel(String baseUrl,
 String accessToken,
 String modelId,
 Duration timeout,
 Double temperature,
 Integer maxNewTokens,
 Boolean returnFullText,
 Boolean waitForModel)

HuggingFaceChatModel

public HuggingFaceChatModel(HuggingFaceChatModel.Builder builder)

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 HuggingFaceChatModel.Builder builder()

withAccessToken

public static HuggingFaceChatModel withAccessToken(String accessToken)