RankingOptions Class

Definition

The RankingOptions.

public class RankingOptions : System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.RankingOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.RankingOptions>
type RankingOptions = class
    interface IJsonModel<RankingOptions>
    interface IPersistableModel<RankingOptions>
Public Class RankingOptions
Implements IJsonModel(Of RankingOptions), IPersistableModel(Of RankingOptions)
Inheritance
RankingOptions
Implements

Constructors

Name Description
RankingOptions()

Initializes a new instance of RankingOptions.

Properties

Name Description
HybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

Ranker

The ranker to use for the file search.

ScoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<RankingOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<RankingOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<RankingOptions>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<RankingOptions>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<RankingOptions>.Write(ModelReaderWriterOptions)

Applies to