Interface HuggingFaceTransformersEmbeddingsParams

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

Hierarchy (view full)

  • Toolkit
    • HuggingFaceTransformersEmbeddingsParams

Implemented by

Properties

model modelName batchSize? pipelineOptions? pretrainedOptions? stripNewLines? timeout?

Properties

model

model: string

Model name to use

modelName

modelName: string

Model name to use Alias for model

OptionalbatchSize

batchSize?: number

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

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