Share via

CompletionsOptions.GenerationSampleCount 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 sets a value that controls how many completions will be internally generated prior to response formulation.

public int? GenerationSampleCount { get; set; }
member this.GenerationSampleCount : Nullable<int> with get, set
Public Property GenerationSampleCount As Nullable(Of Integer)

Property Value

Nullable<Int32>

Remarks

When used together with ChoicesPerPrompt, GenerationSampleCount controls the number of candidate completions and must be greater than ChoicesPerPrompt.

Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure reasonable settings for MaxTokens and StopSequences.

GenerationSampleCount is equivalent to 'best_of' in the REST request schema.

Applies to