Language

SemanticRerankingContent Class

Definition

The input for a semantic reranking operation.

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

Constructors

Name Description
SemanticRerankingContent(String, IEnumerable<String>)

Initializes a new instance of SemanticRerankingContent.

Properties

Name Description
BatchSize

The number of documents processed in each batch.

Documents

The documents to rank against the query.

DocumentType

The format of the submitted documents.

Model

The name of the model used for the semantic reranking operation.

Query

The query used to rank the documents.

ReturnDocuments

Whether the response should include the submitted documents.

ReturnSentenceScore

Whether to return sentence-level scores in the response.

Sort

Whether to return documents sorted by relevance score.

TargetPaths

The property containing text to rank when the document type is JSON. This property is required for JSON documents. Use dot notation for a nested property, for example meta.content. You can specify multiple property paths separated by commas, for example meta.content,id.

TopK

The maximum number of ranked documents to return.

Methods

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

Operators

Name Description
Implicit(SemanticRerankingContent to RequestContent)

Explicit Interface Implementations

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

Applies to