Class: HuggingFaceApiConfiguration
Creates an API configuration for the HuggingFace API.
It calls the API at https://api-inference.huggingface.co/models and uses the HUGGINGFACE_API_KEY env variable by default.
Hierarchy
-
BaseUrlApiConfigurationWithDefaults↳
HuggingFaceApiConfiguration
Constructors
constructor
• new HuggingFaceApiConfiguration(settings?): HuggingFaceApiConfiguration
Parameters
| Name | Type |
|---|---|
settings | Omit<BaseUrlPartsApiConfigurationOptions, "baseUrl"> & { baseUrl?: string | Partial<UrlParts> } & { apiKey?: string } |
Returns
Overrides
BaseUrlApiConfigurationWithDefaults.constructor
Defined in
packages/modelfusion/src/model-provider/huggingface/HuggingFaceApiConfiguration.ts:12
Methods
assembleUrl
▸ assembleUrl(path): string
Parameters
| Name | Type |
|---|---|
path | string |
Returns
string
Inherited from
BaseUrlApiConfigurationWithDefaults.assembleUrl
Defined in
packages/modelfusion/src/core/api/BaseUrlApiConfiguration.ts:47
fixedHeaders
▸ fixedHeaders(): Record<string, string>
Returns
Record<string, string>
Inherited from
BaseUrlApiConfigurationWithDefaults.fixedHeaders
Defined in
packages/modelfusion/src/core/api/BaseUrlApiConfiguration.ts:43
headers
▸ headers(params): Record<string, string>
Parameters
| Name | Type |
|---|---|
params | HeaderParameters |
Returns
Record<string, string>
Inherited from
BaseUrlApiConfigurationWithDefaults.headers
Defined in
packages/modelfusion/src/core/api/AbstractApiConfiguration.ts:31
Properties
baseUrl
• Readonly baseUrl: UrlParts
Inherited from
BaseUrlApiConfigurationWithDefaults.baseUrl
Defined in
packages/modelfusion/src/core/api/BaseUrlApiConfiguration.ts:27
retry
• Optional Readonly retry: RetryFunction
Inherited from
BaseUrlApiConfigurationWithDefaults.retry
Defined in
packages/modelfusion/src/core/api/AbstractApiConfiguration.ts:7
throttle
• Optional Readonly throttle: ThrottleFunction
Inherited from
BaseUrlApiConfigurationWithDefaults.throttle
Defined in
packages/modelfusion/src/core/api/AbstractApiConfiguration.ts:8