Class: HuggingFaceLLM
Unified language model interface
Extends
Constructors
new HuggingFaceLLM()
new HuggingFaceLLM(
init
?):HuggingFaceLLM
Parameters
• init?: HFLLMConfig
Returns
Overrides
Source
packages/llamaindex/src/llm/huggingface.ts:206
Properties
contextWindow
contextWindow:
number
Source
packages/llamaindex/src/llm/huggingface.ts:201
maxTokens?
optional
maxTokens:number
Source
packages/llamaindex/src/llm/huggingface.ts:200
model
private
model:null
|PreTrainedModel
=null
Source
packages/llamaindex/src/llm/huggingface.ts:204
modelName
modelName:
string
Source
packages/llamaindex/src/llm/huggingface.ts:196
temperature
temperature:
number
Source
packages/llamaindex/src/llm/huggingface.ts:198
tokenizer
private
tokenizer:null
|PreTrainedTokenizer
=null
Source
packages/llamaindex/src/llm/huggingface.ts:203
tokenizerName
tokenizerName:
string
Source
packages/llamaindex/src/llm/huggingface.ts:197
topP
topP:
number
Source
packages/llamaindex/src/llm/huggingface.ts:199
Accessors
metadata
get
metadata():LLMMetadata
Returns
Source
packages/llamaindex/src/llm/huggingface.ts:216
Methods
chat()
chat(params)
chat(
params
):Promise
<AsyncIterable
<ChatResponseChunk
>>
Get a chat response from the LLM
Parameters
• params: LLMChatParamsStreaming
<object
, object
>
Returns
Promise
<AsyncIterable
<ChatResponseChunk
>>
Overrides
Source
packages/llamaindex/src/llm/huggingface.ts:243
chat(params)
chat(
params
):Promise
<ChatResponse
<object
>>
Parameters
• params: LLMChatParamsNonStreaming
<object
, object
>
Returns
Promise
<ChatResponse
<object
>>
Overrides
Source
packages/llamaindex/src/llm/huggingface.ts:246
complete()
complete(params)
complete(
params
):Promise
<AsyncIterable
<CompletionResponse
>>
Get a prompt completion from the LLM
Parameters
• params: LLMCompletionParamsStreaming
Returns
Promise
<AsyncIterable
<CompletionResponse
>>
Inherited from
Source
packages/core/dist/llms/index.d.ts:168
complete(params)
complete(
params
):Promise
<CompletionResponse
>
Parameters
• params: LLMCompletionParamsNonStreaming
Returns
Promise
<CompletionResponse
>
Inherited from
Source
packages/core/dist/llms/index.d.ts:169
getModel()
getModel():
Promise
<PreTrainedModel
>
Returns
Promise
<PreTrainedModel
>
Source
packages/llamaindex/src/llm/huggingface.ts:235
getTokenizer()
getTokenizer():
Promise
<PreTrainedTokenizer
>
Returns
Promise
<PreTrainedTokenizer
>
Source
packages/llamaindex/src/llm/huggingface.ts:227
nonStreamChat()
protected
nonStreamChat(params
):Promise
<ChatResponse
<object
>>
Parameters
• params: LLMChatParamsNonStreaming
<object
, object
>
Returns
Promise
<ChatResponse
<object
>>
Source
packages/llamaindex/src/llm/huggingface.ts:255
streamChat()
protected
streamChat(params
):AsyncIterable
<ChatResponseChunk
>
Parameters
• params: LLMChatParamsStreaming
<object
, object
>
Returns
AsyncIterable
<ChatResponseChunk
>