HuggingFaceLLM
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:31
Extends
Section titled “Extends”BaseLLM
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new HuggingFaceLLM(
init?):HuggingFaceLLM
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:42
Parameters
Section titled “Parameters”Returns
Section titled “Returns”HuggingFaceLLM
Overrides
Section titled “Overrides”BaseLLM.constructor
Properties
Section titled “Properties”modelName
Section titled “modelName”modelName:
string
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:32
tokenizerName
Section titled “tokenizerName”tokenizerName:
string
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:33
temperature
Section titled “temperature”temperature:
number
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:34
topP:
number
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:35
maxTokens?
Section titled “maxTokens?”
optionalmaxTokens:number
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:36
contextWindow
Section titled “contextWindow”contextWindow:
number
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:37
Accessors
Section titled “Accessors”metadata
Section titled “metadata”Get Signature
Section titled “Get Signature”get metadata():
LLMMetadata
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:52
Returns
Section titled “Returns”LLMMetadata
Overrides
Section titled “Overrides”BaseLLM.metadata
Methods
Section titled “Methods”getTokenizer()
Section titled “getTokenizer()”getTokenizer():
Promise<PreTrainedTokenizer>
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:64
Returns
Section titled “Returns”Promise<PreTrainedTokenizer>
getModel()
Section titled “getModel()”getModel():
Promise<PreTrainedModel>
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:80
Returns
Section titled “Returns”Promise<PreTrainedModel>
chat()
Section titled “chat()”Call Signature
Section titled “Call Signature”chat(
params):Promise<AsyncIterable<ChatResponseChunk,any,any>>
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:96
Parameters
Section titled “Parameters”params
Section titled “params”LLMChatParamsStreaming
Returns
Section titled “Returns”Promise<AsyncIterable<ChatResponseChunk, any, any>>
Overrides
Section titled “Overrides”BaseLLM.chat
Call Signature
Section titled “Call Signature”chat(
params):Promise<ChatResponse<object>>
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:99
Parameters
Section titled “Parameters”params
Section titled “params”LLMChatParamsNonStreaming
Returns
Section titled “Returns”Promise<ChatResponse<object>>
Overrides
Section titled “Overrides”BaseLLM.chat
nonStreamChat()
Section titled “nonStreamChat()”
protectednonStreamChat(params):Promise<ChatResponse<object>>
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:108
Parameters
Section titled “Parameters”params
Section titled “params”LLMChatParamsNonStreaming
Returns
Section titled “Returns”Promise<ChatResponse<object>>
streamChat()
Section titled “streamChat()”
protectedstreamChat(params):Promise<never>
Defined in: .build/typescript/packages/providers/huggingface/src/llm.ts:143
Parameters
Section titled “Parameters”params
Section titled “params”LLMChatParamsStreaming
Returns
Section titled “Returns”Promise<never>