Class HuggingFaceModel

Implements

LanguageModel

Index

Constructors

Properties

apiKey defaultRequestSettings? family? id maxInputTokens? maxOutputTokens? model name? vendor? version?

Methods

getSettings handleNonStreamingRequest handleStreamingRequest initializeHfInference isStreamingSupported request

Constructors

constructor

new HuggingFaceModel(id, model, apiKey, name?, vendor?, version?, family?, maxInputTokens?, maxOutputTokens?, defaultRequestSettings?): HuggingFaceModel
Parameters
- id: string
  the unique id for this language model. It will be used to identify the model in the UI.
- model: string
  the model id as it is used by the Hugging Face API
- apiKey: (() => undefined | string)
  function to retrieve the API key for Hugging Face
  - - (): undefined | string
    - Returns undefined | string
- Optional name: string
- Optional vendor: string
- Optional version: string
- Optional family: string
- Optional maxInputTokens: number
- Optional maxOutputTokens: number
- Optional defaultRequestSettings: Record<string, unknown>
Returns HuggingFaceModel
- Defined in packages/ai-hugging-face/src/node/huggingface-language-model.ts:58

Properties

apiKey

apiKey: (() => undefined | string)

function to retrieve the API key for Hugging Face

Type declaration

- (): undefined | string
- Returns undefined | string

`Optional` defaultRequestSettings

defaultRequestSettings?: Record<string, unknown>

`Optional` `Readonly` family

family?: string

`Readonly` id

id: string

the unique id for this language model. It will be used to identify the model in the UI.

`Optional` `Readonly` maxInputTokens

maxInputTokens?: number

`Optional` `Readonly` maxOutputTokens

maxOutputTokens?: number

model

model: string

the model id as it is used by the Hugging Face API

`Optional` `Readonly` name

name?: string

`Optional` `Readonly` vendor

vendor?: string

`Optional` `Readonly` version

version?: string

Methods

`Protected` getSettings

getSettings(request): Record<string, unknown>
Parameters
- request: LanguageModelRequest
Returns Record<string, unknown>
- Defined in packages/ai-hugging-face/src/node/huggingface-language-model.ts:80

`Protected` handleNonStreamingRequest

handleNonStreamingRequest(hfInference, request): Promise<LanguageModelTextResponse>
Parameters
- hfInference: HfInference
- request: LanguageModelRequest
Returns Promise<LanguageModelTextResponse>
- Defined in packages/ai-hugging-face/src/node/huggingface-language-model.ts:88

`Protected` handleStreamingRequest

handleStreamingRequest(hfInference, request, cancellationToken?): Promise<LanguageModelResponse>
Parameters
- hfInference: HfInference
- request: LanguageModelRequest
- Optional cancellationToken: CancellationToken
Returns Promise<LanguageModelResponse>
- Defined in packages/ai-hugging-face/src/node/huggingface-language-model.ts:113

`Private` initializeHfInference

initializeHfInference(): HfInference
Returns HfInference
- Defined in packages/ai-hugging-face/src/node/huggingface-language-model.ts:159

`Protected` isStreamingSupported

isStreamingSupported(model): boolean
Parameters
- model: string
Returns boolean
- Defined in packages/ai-hugging-face/src/node/huggingface-language-model.ts:154

request

request(request, cancellationToken?): Promise<LanguageModelResponse>
Parameters
- request: LanguageModelRequest
- Optional cancellationToken: CancellationToken
Returns Promise<LanguageModelResponse>
Implementation of LanguageModel.request
- Defined in packages/ai-hugging-face/src/node/huggingface-language-model.ts:71