Class HuggingFaceLanguageModel

java.lang.Object

dev.langchain4j.model.huggingface.HuggingFaceLanguageModel

All Implemented Interfaces:

LanguageModel

@Deprecated(forRemoval=true,
            since="1.7.0-beta13")
public class HuggingFaceLanguageModel
extends Object
implements LanguageModel

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

Please use OpenAiChatModel from the langchain4j-open-ai module instead:

ChatModel model = OpenAiChatModel.builder()
    .apiKey(System.getenv("HF_API_KEY"))
    .baseUrl("https://router.huggingface.co/v1")
    .modelName("HuggingFaceTB/SmolLM3-3B:hf-inference")
    .build();

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HuggingFaceLanguageModel.Builder	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
HuggingFaceLanguageModel(HuggingFaceLanguageModel.Builder builder)	Deprecated, for removal: This API element is subject to removal in a future version.
HuggingFaceLanguageModel(String baseUrl, String accessToken, String modelId, Duration timeout, Double temperature, Integer maxNewTokens, Boolean returnFullText, Boolean waitForModel)	Deprecated, for removal: This API element is subject to removal in a future version.
HuggingFaceLanguageModel(String accessToken, String modelId, Duration timeout, Double temperature, Integer maxNewTokens, Boolean returnFullText, Boolean waitForModel)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
static HuggingFaceLanguageModel.Builder	builder()	Deprecated, for removal: This API element is subject to removal in a future version.
Response<String>	generate(String prompt)	Deprecated, for removal: This API element is subject to removal in a future version. Generate a response to the given prompt.
static HuggingFaceLanguageModel	withAccessToken(String accessToken)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class Object

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

Methods inherited from interface LanguageModel

generate

Constructor Details

HuggingFaceLanguageModel

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

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

HuggingFaceLanguageModel

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

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

HuggingFaceLanguageModel

public HuggingFaceLanguageModel(HuggingFaceLanguageModel.Builder builder)

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

Method Details

generate

public Response<String> generate(String prompt)

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

Description copied from interface: LanguageModel

Generate a response to the given prompt.

Specified by:

generate in interface LanguageModel

Parameters:

prompt - the prompt.

Returns:

the response.

builder

public static HuggingFaceLanguageModel.Builder builder()

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

withAccessToken

public static HuggingFaceLanguageModel withAccessToken(String accessToken)

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