Interface HuggingFaceInferenceEmbeddingsParams

Interface that extends EmbeddingsParams and defines additional parameters specific to the HuggingFaceInferenceEmbeddings class.

interface HuggingFaceInferenceEmbeddingsParams {
    apiKey?: string;
    endpointUrl?: string;
    maxConcurrency?: number;
    maxRetries?: number;
    model?: string;
    onFailedAttempt?: FailedAttemptHandler;
}

Hierarchy

  • EmbeddingsParams
    • HuggingFaceInferenceEmbeddingsParams

Implemented by

Properties

apiKey? endpointUrl? maxConcurrency? maxRetries? model? onFailedAttempt?

Properties

OptionalapiKey

apiKey?: string

OptionalendpointUrl

endpointUrl?: string

OptionalmaxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

OptionalmaxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

Optionalmodel

model?: string

OptionalonFailedAttempt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

Settings

Member Visibility

On This Page

Properties