NvidiaDocumentEmbedder Parameters

Check the init parameters you can specify for NvidiaTextEmbeder.

YAML Init Parameters

These are the parameters you can specify in pipeline YAML:

ParameterTypePossible valuesDescription
api_keySecretDefault: Secret.from_env_var("NVIDIA_API_KEY")The Nvidia API key.
Required.
modelStringDefault: NV-Embed-QA,The name of the model to use.
Required.
api_urlStringDefault: "https://ai.api.nvidia.com/v1/retrieval/nvidia"Custom API URL for NVIDIA NIM. The URL follows the format: https://host:port.
Required.
prefixStringDefault: ""(empty string)A string to add at the beginning of each text. Can be used to prepend the text with an instruction, as required by some embedding models, such as E5 and bge.
Required.
suffixStringDefault: ""(empty string)A text string to add at the end of each text.
Required.
batch_sizeIntegerDefault: 32The count of documents to embed at once. Must be a value below 50.
Required.
progress_barBooleanTrue
False
Default: True
If True, shows a progress bar during embedding.
Required.
meta_fields_to_embedList of stringsDefault: NoneA list of metadata fields you want to embed along with the document text.
Optional.
embedding_separatorStringDefault: "\n"Separator to concatenate metadata fields into the document text.
Required.
truncateUnion of EmbeddingTruncateMode and stringSTART
END
Default: None
Specifies how inputs longer than the maximum token length should be truncated. Possible values:

- START: The input is truncated from the start.
- END: The input is truncated from the end.
- None: The behavior depends on the model. See model documentation for information.
Optional.