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

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

withAccessToken

public static HuggingFaceChatModel withAccessToken(String accessToken)