RankingOptions Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The RankingOptions.
public class RankingOptions : Azure.AI.AgentServer.Contracts.Generated.Common.IUtf8JsonSerializable, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.RankingOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.RankingOptions>type RankingOptions = class
interface IUtf8JsonSerializable
interface IJsonModel<RankingOptions>
interface IPersistableModel<RankingOptions>Public Class RankingOptions
Implements IJsonModel(Of RankingOptions), IPersistableModel(Of RankingOptions), IUtf8JsonSerializable- Inheritance
-
RankingOptions
- Implements
Constructors
| Name | Description |
|---|---|
| RankingOptions() |
Initializes a new instance of RankingOptions. |
| RankingOptions(Nullable<RankingOptionsRanker>, Nullable<Single>, IDictionary<String,BinaryData>) |
Initializes a new instance of RankingOptions. |
Properties
| Name | Description |
|---|---|
| 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 |
|---|---|
| DeserializeRankingOptions(JsonElement, ModelReaderWriterOptions) | |
| FromResponse(Response) |
Deserializes the model from a raw response. |
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
| ToRequestContent() |
Convert into a RequestContent. |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<RankingOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<RankingOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<RankingOptions>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<RankingOptions>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<RankingOptions>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
| IUtf8JsonSerializable.Write(Utf8JsonWriter) | |
