Class RankingOptions

Namespace

OpenAI

Assembly

OpenAI-DotNet.dll

The ranking options for the file search. https://platform.openai.com/docs/assistants/tools/file-search/customizing-file-search-settings

public sealed class RankingOptions

Inheritance

object

RankingOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RankingOptions(string, float)

Constructor.

[JsonConstructor]
public RankingOptions(string ranker = "auto", float scoreThreshold = 0)

Parameters

ranker string

The ranker to use for the file search. If not specified will use the auto ranker.

scoreThreshold float

The score threshold for the file search. All values must be a floating point number between 0 and 1.

Exceptions

ArgumentOutOfRangeException

Properties

Ranker

The ranker to use for the file search.

[JsonPropertyName("ranker")]
public string Ranker { get; }

Property Value

string

ScoreThreshold

The score threshold for the file search.

[JsonPropertyName("score_threshold")]
public float ScoreThreshold { get; }

Property Value

float