Share via

CompletionsOptions.NucleusSamplingFactor Property

  • Reference

Definition

Namespace:
Azure.AI.OpenAI
Assembly:
Azure.AI.OpenAI.dll
Package:
Azure.AI.OpenAI v1.0.0-beta.17
Source:
CompletionsOptions.cs

Gets or set a an alternative value to Temperature, called nucleus sampling, that causes the model to consider the results of the tokens with NucleusSamplingFactor probability mass.

public float? NucleusSamplingFactor { get; set; }
member this.NucleusSamplingFactor : Nullable<single> with get, set
Public Property NucleusSamplingFactor As Nullable(Of Single)

Property Value

Nullable<Single>

Remarks

As an example, a value of 0.1 will cause only the tokens comprising the top 10% of probability mass to be considered.

It is not recommended to modify Temperature and NucleusSamplingFactor for the same completions request as the interaction of these two settings is difficult to predict.

NucleusSamplingFactor is equivalent to 'top_p' in the REST request schema.

Applies to