AzureOpenAIDocumentEmbedder Parameters

Check the init and rumtime parameters you can pass for AzureOpenAIDocumentEmbedder.

YAML Init Parameters

These are the parameters you can specify in pipeline YAML:

ParameterTypePossible ValuesDescription
undo_scale_scoreBooleanTrue
False
Default: False
Unscales the scores assigned by EmbeddingRetriever or Ranker using the logit function.
Mandatory.
scale_scoreBooleanTrue
False
Default: True
Rescales the scores using the sigmoid function.
Mandatory.
midpointFloatDefault: 0.0Specifies the midpoint value for scaling score. The midpoint value is the value mapped to 50%. Used if scale_score=True.
Mandatory.
spread_factorFloatDefault: 1.0If scale_score=True, pushes scores closer or farther away from 50%. A higher spread factor results in scores closer to 0% or 100%. A lower spread factor results in scores closer to 50%. This value must be greater than 0.
Mandatory.
top_spread_factorFloatDefault: NoneIf scale_score=True, pushes scores that are above midpoint closer or farther away from 100%. A higher top spread factor results in scores closer to 100%, while a lower top spread factor results in scores closer to 50%. This value must be greater than 0.
top_spread_factor takes precedence over spread_factor if both are specified.
Optional.
bottom_spread_factorFloatDefault: NoneIf scale_score=True, pushes scores that are below midpoint closer or farther away from 0%. A higher bottom_spread_factor results in scores closer to 0%. A lower bottom_spread_factor results in scores closer to 50%. This value must be greater than 0.
bottom_spread_factor takes precedence over spread_factor if both are specified.
Optional.
thresholdFloatDefault: NoneSets a threshold for document score. If set, only documents above this threshold (after all adjustments) are returned.
Optional.

REST API Runtime Parameters

These are the runtime parameters you can pass in the body of the request to the Search endpoint:

ParameterTypePossible ValuesDescription
undo_scale_scoreBooleanTrue
False
Default: False
Unscales the scores assigned by EmbeddingRetriever or Ranker using the logit function.
Mandatory.
scale_scoreBooleanTrue
False
Default: True
Rescales the scores using the sigmoid function.
Mandatory.
midpointFloatDefault: 0.0Specifies the midpoint value for scaling score. The midpoint value is the value mapped to 50%. Used if scale_score=True.
Mandatory.
spread_factorFloatDefault: 1.0If scale_score=True, pushes scores closer or farther away from 50%. A higher spread factor results in scores closer to 0% or 100%. A lower spread factor results in scores closer to 50%. This value must be greater than 0.
Mandatory.
top_spread_factorFloatDefault: NoneIf scale_score=True, pushes scores that are above midpoint closer or farther away from 100%. A higher top spread factor results in scores closer to 100%, while a lower top spread factor results in scores closer to 50%. This value must be greater than 0.
top_spread_factor takes precedence over spread_factor if both are specified.
Optional.
bottom_spread_factorFloatDefault: NoneIf scale_score=True, pushes scores that are below midpoint closer or farther away from 0%. A higher bottom_spread_factor results in scores closer to 0%. A lower bottom_spread_factor results in scores closer to 50%. This value must be greater than 0.
bottom_spread_factor takes precedence over spread_factor if both are specified.
Optional.
thresholdFloatDefault: NoneSets a threshold for document score. If set, only documents above this threshold (after all adjustments) are returned.
Optional.