Class HuggingFaceModel

See also VS Code ILanguageModelChatMetadata

Implements

LanguageModel

Index

Constructors

Properties

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

Methods

getSettings handleNonStreamingRequest handleStreamingRequest isStreamingSupported request

Constructors

constructor

new HuggingFaceModel(
    id: string,
    model: string,
    status: LanguageModelStatus,
    apiKey: () => undefined | string,
    name?: string,
    vendor?: string,
    version?: string,
    family?: string,
    maxInputTokens?: number,
    maxOutputTokens?: number,
): 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
- status: LanguageModelStatus
- apiKey: () => undefined | string
  function to retrieve the API key for Hugging Face
- Optionalname: string
- Optionalvendor: string
- Optionalversion: string
- Optionalfamily: string
- OptionalmaxInputTokens: number
- OptionalmaxOutputTokens: number
Returns HuggingFaceModel
- Defined in node/huggingface-language-model.ts:71

Properties

apiKey

apiKey: () => undefined | string

function to retrieve the API key for Hugging Face

`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

status

status: LanguageModelStatus

`Optional` `Readonly`vendor

vendor?: string

`Optional` `Readonly`version

version?: string

Methods

`Protected`getSettings

getSettings(request: LanguageModelRequest): Record<string, unknown>
Parameters
- request: LanguageModelRequest
Returns Record<string, unknown>
- Defined in node/huggingface-language-model.ts:93

`Protected`handleNonStreamingRequest

handleNonStreamingRequest(
hfInference: HfInference,
request: LanguageModelRequest,
): Promise<LanguageModelTextResponse>
Parameters
- hfInference: HfInference
- request: LanguageModelRequest
Returns Promise<LanguageModelTextResponse>
- Defined in node/huggingface-language-model.ts:97

`Protected`handleStreamingRequest

handleStreamingRequest(
    hfInference: HfInference,
    request: LanguageModelRequest,
    cancellationToken?: CancellationToken,
): Promise<LanguageModelResponse>
Parameters
- hfInference: HfInference
- request: LanguageModelRequest
- OptionalcancellationToken: CancellationToken
Returns Promise<LanguageModelResponse>
- Defined in node/huggingface-language-model.ts:122

`Protected`isStreamingSupported

isStreamingSupported(model: string): boolean
Parameters
- model: string
Returns boolean
- Defined in node/huggingface-language-model.ts:163

request

request(
request: LanguageModelRequest,
cancellationToken?: CancellationToken,
): Promise<LanguageModelResponse>
Parameters
- request: LanguageModelRequest
- OptionalcancellationToken: CancellationToken
Returns Promise<LanguageModelResponse>
Implementation of LanguageModel.request
- Defined in node/huggingface-language-model.ts:84