Package org.springframework.ai.huggingface.client

Class HuggingfaceAiClient

java.lang.Object

org.springframework.ai.huggingface.client.HuggingfaceAiClient

All Implemented Interfaces:

AiClient

public class HuggingfaceAiClient
extends Object
implements AiClient

An implementation of AiClient that interfaces with HuggingFace Inference Endpoints for text generation.

Author:

Mark Pollack

Constructor Summary

Constructors

Constructor	Description
HuggingfaceAiClient(String apiToken, String basePath)	Constructs a new HuggingfaceAiClient with the specified API token and base path.

Method Summary

Modifier and Type	Method	Description
AiResponse	generate(Prompt prompt)	Generate text based on the provided prompt.
int	getMaxNewTokens()	Gets the maximum number of new tokens to be generated.
void	setMaxNewTokens(int maxNewTokens)	Sets the maximum number of new tokens to be generated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.client.AiClient

generate

Constructor Details

HuggingfaceAiClient

public HuggingfaceAiClient(String apiToken,
 String basePath)

Constructs a new HuggingfaceAiClient with the specified API token and base path.

Parameters:

apiToken - The API token for HuggingFace.

basePath - The base path for API requests.

Method Details

generate

public AiResponse generate(Prompt prompt)

Generate text based on the provided prompt.

Specified by:

generate in interface AiClient

Parameters:

prompt - The input prompt based on which text is to be generated.

Returns:

AiResponse containing the generated text and other related details.

getMaxNewTokens

public int getMaxNewTokens()

Gets the maximum number of new tokens to be generated.

Returns:

The maximum number of new tokens.

setMaxNewTokens

public void setMaxNewTokens(int maxNewTokens)

Sets the maximum number of new tokens to be generated.

Parameters:

maxNewTokens - The maximum number of new tokens.