Interface HuggingFaceTransformersEmbeddingsParams

interface HuggingFaceTransformersEmbeddingsParams {
    batchSize?: number;
    maxConcurrency?: number;
    maxRetries?: number;
    model: string;
    modelName: string;
    onFailedAttempt?: FailedAttemptHandler;
    pipelineOptions?: FeatureExtractionPipelineOptions;
    pretrainedOptions?: PretrainedOptions;
    stripNewLines?: boolean;
    timeout?: number;
}

Hierarchy

  • EmbeddingsParams
    • HuggingFaceTransformersEmbeddingsParams

Implemented by

Properties

batchSize? maxConcurrency? maxRetries? model modelName onFailedAttempt? pipelineOptions? pretrainedOptions? stripNewLines? timeout?

Properties

OptionalbatchSize

batchSize?: number

The maximum number of documents to embed in a single request.

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.

model

model: string

Model name to use

modelName

modelName: string

Model name to use Alias for model

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.

OptionalpipelineOptions

pipelineOptions?: FeatureExtractionPipelineOptions

Optional parameters for the pipeline.

OptionalpretrainedOptions

pretrainedOptions?: PretrainedOptions

Optional parameters for the pretrained model.

OptionalstripNewLines

stripNewLines?: boolean

Whether to strip new lines from the input text. This is recommended by OpenAI, but may not be suitable for all use cases.

Optionaltimeout

timeout?: number

Timeout to use when making requests to OpenAI.

Settings

Member Visibility

On This Page

Properties